-
Cisco WebEx Social API Reference Guide, Release 3.0
-
Preface
-
Introduction to the Cisco WebEx Social API
-
Authorization and Authentication
-
Resources
-
User Resource Operations
-
Community Resource Operations
-
Membership Request Resource Operations
-
Post Resource Operations
-
Document File Resource Operations
-
Document Folder Resource Operations
-
File Resource Operations
-
API Consumer Resource Operations
-
Search Operation
-
Response Examples
-
Index
-
Feedback
Table Of Contents
Get Information about Yourself
Get Information about a User with the Designated E-mail Address or Screen Name
Get Information about Your Profile Images
Get Information about the Profile Images of a Designated User
Upload Profile Image for Yourself
Get Information about Communities to which You Belong
Get Information about Communities to which a User Belongs
Get Information about Communities that are Visible on Your Profile
Get Information about Communities that are Visible on the Profile of a User
Get Information about Posts that are Visible on Your Profile
Get Information about Posts that are in Your Library
Get Information about Recent Posts that are in Your Library
Get Information about Posts that are Visible on the Profile of a User
Get Information about the Latest Micropost that You Made
Get Information about the Latest Micropost that a User Made
Get Information about Posts that You have Marked as Favorites
Get Information about Posts that a User has Marked as Favorites
Get Information about Your Document Library
Get Information about the Document Library of a User
Get Information about Document Files in Your Document Library
Get Information about Document Files in Your Document Library that are Authored by You
Get Information about Document Files in Your Document Library that are Authored by a Designated User
Get Information about Document Files in the Document Library of a User
Get Information about the Designated Custom Attributes of a User
Get Information about All Custom Attributes of a User
Update Custom Attributes of a User
Get Information about All Activities that are Visible to You
Get Information about All Activities that Appears in Your Watch List
Get Information about all Activities that Appear in the Profile Page of a User
Create a Favorite Relationship for Yourself
Remove a Favorite Relationship for Yourself
Create a Follow Relationship for Yourself
Get Information about Users that are Following You
Get the Number of Users that are Following You
Get Information about Users that are Following the Designated User
Get the Number of Users that are Following the Designated User
Get Information about Users that You are Following
Get the Number of Users that You are Following
Get Information about Users that the Designated User is Following
Get the Number of Users that the Designated User is Following
Remove Your Following of Another Cisco WebEx Social User
Get Information about Users that You and the Designated User Both are Following
Get the Number of Users that You and the Designated User Both are Following
Create a Like Relationship for Yourself
Remove a Like Relationship for Yourself
User Resource Operations
A Cisco WebEx Social user is someone who is registered in the Cisco WebEx Social system. The Cisco WebEx Social API User resource operations let you obtain information about users and perform various operations for users.
Table 4-1 provides a summary of the User 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
•
•
•
•
•
In these sections, "you," "your," and "yourself" refer to the authenticated user who is executing an operation.
Table 4-1 User Resource Operations Summary
Retrieves information about you
Retrieves information about the designated user
Retrieves information about the designated users
Get Information about a User with the Designated E-mail Address or Screen Name
Retrieves information about the user with the designated e-mail address or Cisco WebEx Social screen name
Updates information for the designated user
Retrieves information about your Cisco WebEx Social profile images
Get Information about the Profile Images of a Designated User
Retrieves information about the Cisco WebEx Social profile images of the designated user
Uploads your Cisco WebEx Social profile image
Retrieves information about communities to which you belong
Retrieves information about all communities to which the designated user belongs
Get Information about Communities that are Visible on Your Profile
Retrieves information about communities that are visible on your profile
Get Information about Communities that are Visible on the Profile of a User
Retrieves information about communities that are visible on the profile of the designated user
Get Information about Posts that are Visible on Your Profile
Retrieves information about all posts that are visible on your profile
Retrieves information about all posts that are in your library
Retrieves information about posts that are in your library and that have been posted within the past 2 weeks, excluding posts that you made
Get Information about Posts that are Visible on the Profile of a User
Retrieves information about all posts that are visible on the profile of the designated user
Retrieves information about the latest micropost that you made
Retrieves information about the latest micropost that the designated user made
Get Information about Posts that You have Marked as Favorites
Retrieves information about Favorite resources that have as the destination the posts that you have marked as favorites
Get Information about Posts that a User has Marked as Favorites
Retrieves information about Favorite resources that have as the destination the posts that the designated user has marked as favorites
Retrieves information about your document library
Retrieves information about the document library of a designated user
Get Information about Document Files in Your Document Library
Retrieves information about all documents that are in your document library
Get Information about Document Files in Your Document Library that are Authored by You
Retrieves information about document files that are in your document library and that are authored by you
Get Information about Document Files in Your Document Library that are Authored by a Designated User
Retrieves information about document files that are in your document library and that are authored by the designated user
Get Information about Document Files in the Document Library of a User
Retrieves information about all document files that are in the document library of the designated user
Retrieves information about document files that are in the document library of the designated user and that are authored by the designated user
Get Information about the Designated Custom Attributes of a User
Retrieves information about the designated custom attributes of the designated user
Retrieves information about all custom attributes of the designated user
Updates designated custom attributes for the designated user
Get Information about All Activities that are Visible to You
Retrieves information about all activities that are visible to you in Cisco WebEx Social
Get Information about All Activities that Appears in Your Watch List
Retrieves information about all activities that appear in your Cisco WebEx Social watch list
Get Information about all Activities that Appear in the Profile Page of a User
Retrieves information about all activities that appear in the profile page of the designated user
Creates a favorite relationship between you and a Cisco WebEx Social post
Removes the designated favorite relationship in which you favorited a Cisco WebEx Social post
Creates a follow relationship for yourself in which you are following another Cisco WebEx Social user
Retrieves Follow resources that have as the destination the users that are following you
Retrieves the number of users that are following you
Get Information about Users that are Following the Designated User
Retrieves Follow resources that have as the destination the users that are following the designated user
Get the Number of Users that are Following the Designated User
Retrieves the number of users that are following the designated user
Retrieves Follow resources that have as the destination the users that you are following
Retrieves the number of users that you are following
Get Information about Users that the Designated User is Following
Retrieves Follow resources that have as the destination the users that the designated user is following
Get the Number of Users that the Designated User is Following
Retrieves the number of users that the designated user is following
Remove the designated follow relationship in which you are following another Cisco WebEx Social user
Get Information about Users that You and the Designated User Both are Following
Retrieves Follow resources that have as the destination the users you and a designated user both are following
Get the Number of Users that You and the Designated User Both are Following
Retrieves the number of users that you and a designated user both are following
Creates a like relationship in which you like a Cisco WebEx Social post
Removes the designated like relationship in which you like a Cisco WebEx Social post
Get Information about Yourself
Purpose
Retrieves information about you.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one User resource (the "User Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@meAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the User resource. For an example, see the "User Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@meAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the User resource. For an example, see the "User Resource Response: JSON Format, One Resource Returned" section.
Get Information about a User
Purpose
Retrieves information about the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user about whom to retrieve information. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one User resource (the "User Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234Accept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the User resource. For an example, see the "User Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/1234Accept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the User resource. For an example, see the "User Resource Response: JSON Format, One Resource Returned" section.
Get Information about Users
Purpose
Retrieves information about the designated users.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id[,...[user_id]]
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of a user about whom to retrieve information. When specifying multiple identifiers, separate each one with a comma. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234,9876Accept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the User resource. For an example, see the "User Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234,9876Accept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the User resource. For an example, see the "User Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about a User with the Designated E-mail Address or Screen Name
Purpose
Retrieves information about the user with the designated e-mail address or Cisco WebEx Social screen name.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users?filterBy={email|screenName}
&filterValue=value[&query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
value
If filterBy equals email, value is the e-mail address of the user about whom to retrieve information.
If filterBy equals screenName, value is the Cisco WebEx Social screen name of the user about whom to retrieve information.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one User resource (the "User Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users?filterBy=screenName&filterValue=patkimAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the User resource. For an example, see the "User Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users?filterBy=screenName&filterValue=patkimAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the User resource. For an example, see the "User Resource Response: JSON Format, One Resource Returned" section.
Update Information for a User
Purpose
Updates information for the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to update information. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
Request Payload
The request payload includes fields from the User resource (Table 3-33 describes these fields):
—
emails
endWorkHour
firstName
friendlyJobTitle
lastName
legalHold1
manager
phones
startWorkHour
tags
timeZone
1 Can be updated only by a user with the Cisco WebEx Social system administrator privilege.
Response
Standard response (see the "API Responses" section) with an HTTP header only.
XML Example
Request
PUT http://webexsocialserver/api/quad/rest/users/10332Accept:application/xmlContent-Type: application/xml<user><firstName>Pat<firstName><lastName>Kim</lastName><emails><id>110004</id><address>patkim@email.com</address><primary>false</primary></emails><phones><id>110005</id><primary>false</primary><number>8885556654</number><extension></extension><type>mobile</type></phones><endWorkHour>22</endWorkHour><friendlyJobTitle>Software Tester</friendlyJobTitle><startWorkHour>10</startWorkHour><tags><name>cooking</name></tags><tags><name>reading</name></tags><timeZone>America/Los_Angeles</timeZone><status>ACTIVE</status><legalHold>NOHOLD</STATUS><manager><id>10426</id></manager></user>Response
HTTP/1.1 204 No Content
JSON Example
Request
PUT http://webexsocialserver/api/quad/rest/users/10332Accept:application/jsonContent-Type: application/json{"firstName":"pat","lastName":"kim","endWorkHour": 22,"friendlyJobTitle": "Software Developer","startWorkHour": 10,"tags":[{"name":"quad",},{"name":"java"}],"phones": [{"id": 110005,"primary": false,"number": "8885556654","extension": "","type": "mobile"}],"manager":[{"id":1234}],"emails": [{"id": 110004,"resource": "http://quad.cisco.com/schema/1.0/email","address": " patkim@email.com","primary": false}],"status":"ACTIVE","legalHold":"NOHOLD","timeZone": "America/Los_Angeles"}Response
HTTP/1.1 204 No Content
Get Information about Your Profile Images
Purpose
Retrieves information about your Cisco WebEx Social profile images.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/images/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 ProfileImage resources (the "ProfileImage Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/images/@profileAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the ProfileImage resource. For an example, see the "ProfileImage Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/images/@profileAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the ProfileImage resource. For an example, see the "ProfileImage Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about the Profile Images of a Designated User
Purpose
Retrieves information about the Cisco WebEx Social profile images of the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/images/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about the profile image. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 ProfileImage resources (the "ProfileImage Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/images/@profileAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the ProfileImage resource. For an example, see the "ProfileImage Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/images/@profileAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the ProfileImage resource. For an example, see the "ProfileImage Resource Response: JSON Format, Multiple Resources Returned" section.
Upload Profile Image for Yourself
Purpose
Uploads your Cisco WebEx Social profile image to the Cisco WebEx Social server. When you upload an image, the system automatically creates six versions of that image in these sizes:
•
•
•
•
•
•
Availability
Cisco WebEx Social 3.0 and later.
Request
POST
http://server[:port_number]/api/quad/rest/users/@me/images/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
Image to be uploaded.
The HTTP Content-Type header must be multipart/form-data for this request. The form-data key must be specified as file=image_to_upload.
Response
Standard response (see the "API Responses" section) with a response payload that can include one or more ProfileImage resources (the "ProfileImage Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
POST http://quadserver]/api/quad/rest/users/@me/images/@profileaccept: application/xmlcontent-length: 87899expect: 100-continuecontent-type: multipart/form-data; boundary=----------------------------02a4bb521c19------------------------------02a4bb521c19Content-Disposition: form-data; name="file"; filename="ProfilePhoto.jpg"<binary_file>------------------------------02a4bb521c19--Response
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the ProfileImage resource. For an example, see the "ProfileImage Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
POST http://quadserver]/api/quad/rest/users/@me/images/@profileaccept: application/jsoncontent-length: 87899expect: 100-continuecontent-type: multipart/form-data; boundary=----------------------------02a4bb521c19------------------------------02a4bb521c19Content-Disposition: form-data; name="file"; filename="ProfilePhoto.jpg"<binary_file>------------------------------02a4bb521c19--Response
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the ProfileImage resource. For an example, see the "ProfileImage Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about Communities to which You Belong
Purpose
Retrieves information about communities to which you belong.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/communities
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Community resources (the "Community Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/communitiesAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Community resource. For an example, see the "Community Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/communitiesAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Community resource. For an example, see the "Community Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about Communities to which a User Belongs
Purpose
Retrieves information about all communities to which the designated user belongs. You must have the Cisco WebEx Social system administrator privilege to retrieve information for a user other than yourself.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/communities
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about belonged-to communities. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Community resources (the "Community Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/communitiesAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Community resource. For an example, see the "Community Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/communitiesAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Community resource. For an example, see the "Community Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about Communities that are Visible on Your Profile
Purpose
Retrieves information about communities that are visible on your profile.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/communities/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Community resources (the "Community Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/communities/@profileAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Community resource. For an example, see the "Community Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/communities/@profileAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Community resource. For an example, see the "Community Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about Communities that are Visible on the Profile of a User
Purpose
Retrieves information about communities that are visible on the profile of the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/communities/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about communities. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Community resources (the "Community Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/communities/@profileAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Community resource. For an example, see the "Community Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/communities/@profileAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Community resource. For an example, see the "Community Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about Posts that are Visible on Your Profile
Purpose
Retrieves information about all posts that are visible on your profile.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/posts/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Post resources (the "Post Resource" section describes this resource). XML, JSON, and Atom formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@profileAccept: application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@profileAccept: application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Post resource. For an example, see the "Post Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@profileAccept: application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: Atom Format, Multiple Resources Returned" section.
Get Information about Posts that are in Your Library
Purpose
Retrieves information about all posts that are in your library.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/{@me|user_id}/posts
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Your user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Post resources (the "Post Resource" section describes this resource). XML, JSON, and Atom formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/postsAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/postsAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Post resource. For an example, see the "Post Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/postsAccept:application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: Atom Format, Multiple Resources Returned" section.
Get Information about Recent Posts that are in Your Library
Purpose
Retrieves information about recent posts that are in your library, excluding posts that you made. "Recent" means posts that were added or edited within the past 2 weeks.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/{@me|user_id}/posts/@recent
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Your user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Post resources (the "Post Resource" section describes this resource). XML, JSON, and Atom formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@recentAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@recentAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Post resource. For an example, see the "Post Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@recentAccept:application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: Atom Format, Multiple Resources Returned" section.
Get Information about Posts that are Visible on the Profile of a User
Purpose
Retrieves information about all posts that are visible on the profile of the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/posts/@profile
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve posts. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Post resources (the "Post Resource" section describes this resource). XML, JSON, and Atom formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/posts/@profileAccept: application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/posts/@profileAccept: application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Post resource. For an example, see the "Post Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/posts/@profileAccept: application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: Atom Format, Multiple Resources Returned" section.
Get Information about the Latest Micropost that You Made
Purpose
Retrieves information about the latest micropost that you made.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/posts/@status
[?query_parameters]
Where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one Post resource (the "Post Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@statusAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/posts/@statusAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Post resource. For an example, see the "Post Resource Response: JSON Format, Multiple Resources Returned" section.
Get Information about the Latest Micropost that a User Made
Purpose
Retrieves information about the latest micropost that the designated user made.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]//api/quad/rest/users/user_id/posts/@status
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user from whom to retrieve the latest micropost. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one Post resource (the "Post Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/12345/posts/@statusAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Post resource. For an example, see the "Post Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/12345/posts/@statusAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Post resource. For an example, see the "Post Resource Response: JSON Format, One Resource Returned" section.
Get Information about Posts that You have Marked as Favorites
Purpose
Retrieves information about Favorite resources that have as the destination the posts that you have marked as favorites.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/favorite/
@favoritingposts[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Favorite resources (the "Favorite Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://quadserver/aapi/quad/rest/users/@me/favoriteAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Favorite resource. For an example, see the "Favorite Resource Response with Post Resource in Destination Field: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://quadserver/aapi/quad/rest/users/@me/favoriteAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Favorite resource. For an example, see the "Favorite Resource Response with Post Resource in Destination Field: JSON Format, Multiple Resources Returned" section.
Get Information about Posts that a User has Marked as Favorites
Purpose
Retrieves information about Favorite resources that have as the destination the posts that the designated user has marked as favorites.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/favorite/
@favoritingposts[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about posts that the user marked as favorites. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
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 Favorite resources (the "Favorite Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/favoriteAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Favorite resource. For an example, see the "Favorite Resource Response with Post Resource in Destination Field: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/favoriteAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Favorite resource. For an example, see the "Favorite Resource Response with Post Resource in Destination Field: JSON Format, Multiple Resources Returned" section.
Get Information about Your Document Library
Purpose
Retrieves information about your document library.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/documentlibrary
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of top-level document folders (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibraryAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibraryAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about the Document Library of a User
Purpose
Retrieves information about the document library of a designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/documentlibrary
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve document library information. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of top-level document folders (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users1234/documentlibraryAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users1234/documentlibraryAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about Document Files in Your Document Library
Purpose
Retrieves information about all document files that are in your document library.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/documentlibrary/@recent[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of all document files in your document library (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibrary/@recentAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibrary/@recentAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about Document Files in Your Document Library that are Authored by You
Purpose
Retrieves information about document files that are in your document library and that are authored by you.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/documentlibrary?
?filterBy=author&filterValue=@me[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of document files that are authored by you (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibrary?filterBy=author &filterValue=@meAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
http://webexsocialserver/api/quad/rest/users/@me/documentlibrary?filterBy=author &filterValue=@meAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about Document Files in Your Document Library that are Authored by a Designated User
Purpose
Retrieves information about document files that are in your document library and that are authored by the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/documentlibrary
?filterBy=author&filterValue=user_id[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user who authored the document files. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of document files that are authored by the designated user (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibrary?filterBy=author &filterValue=1234Accept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/documentlibrary?filterBy=author &filterValue=1234Accept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about Document Files in the Document Library of a User
Purpose
Retrieves information about all document files that are in the document library of the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/documentlibrary/
@recent[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user whose document library contains the document files about which information is to be retrieved. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of all document files in the document library or the designated user (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/documentlibrary/@recentAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/documentlibrary/@recentAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about Document Files in the Document Library of a User that are Authored by the Designated User
Purpose
Retrieves information about document files that are in the document library of the designated user and that are authored by the designated user. These users can be the same or different people.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id_(library)/
documentlibrary?filterBy=author&filterValue=user_id_(author)
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id_(library)
Identifier of the user whose document library that contains the document files about which information is to be retrieved. For information about obtaining the identifier that you need, see the instructions for obtaining a user_id in "Identifiers of Cisco WebEx Social Entities" section.
user_id_(author)
Identifier of the user who authored the document files about which information is to be retrieved. For information about obtaining the identifier that you need, see the instructions for obtaining a user_id in "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that can include one DocumentLibrary resource that contains representations of document files that are authored by the designated user (the "DocumentLibrary Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/documentlibrary ?filterBy=author&filterValue=9876Accept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/documentlibrary ?filterBy=author&filterValue=9876Accept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the DocumentLibrary resource. For an example, see the "DocumentLibrary Resource Response: JSON Format, One Resource Returned" section.
Get Information about the Designated Custom Attributes of a User
Purpose
Retrieves information about the designated custom attributes of the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/customattributes/
attributes
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about designated custom attributes. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
attributes
Comma-separated string of custom attributes about which to retrieve information. To retrieve the custom attributes that you can designate here, use the operation that the "Get Information about All Custom Attributes of a User" section describes.
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 CustomAttribute resources (the "CustomAttribute Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/110006/customattributes/DOB,LOCATIONAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:response xmlns:ns2="http://quad.cisco.com/ns/1.0/xml"><statusCode>200</statusCode><startIndex>0</startIndex><itemsPerPage>2</itemsPerPage><totalResults>2</totalResults><filtered>false</filtered><sorted>false</sorted><entry><customAttribute><dataType>String</dataType><id>0</id><key>DOB</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value>01/01/1980</value></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>LOCATION</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value>NewLocation</value></customAttribute></entry></ns2:response>JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/110006/customattributes/DOB,LOCATIONAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/json{ "entry" : [ { "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "DOB","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : "01/01/1980"} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "LOCATION","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : "NewLocation"} }],"filtered" : false,"itemsPerPage" : 2,"serverMessages" : null,"sorted" : false,"startIndex" : 0,"statusCode" : 200,"totalResults" : 2}Get Information about All Custom Attributes of a User
Purpose
Retrieves information about all custom attributes of the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about all custom attributes. For information about obtaining 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 or more CustomAttribute resources (the "CustomAttribute Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/customattributesAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:response xmlns:ns2="http://quad.cisco.com/ns/1.0/xml"><statusCode>200</statusCode><startIndex>0</startIndex><itemsPerPage>17</itemsPerPage><totalResults>17</totalResults><filtered>false</filtered><sorted>false</sorted><entry><customAttribute><dataType>String[]</dataType><id>0</id><key>text</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">12345678</dataSelectionValues><dataType>int[]</dataType><id>0</id><key>multivalue</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String[]</dataType><id>0</id><key>test</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">12</dataSelectionValues><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">23</dataSelectionValues><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">45</dataSelectionValues><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">56</dataSelectionValues><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">67</dataSelectionValues><dataType>String[]</dataType><id>0</id><key>selectiontextvalues</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_LAST_PHONE_MODE</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>int[]</dataType><id>0</id><key>multiple int</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">12</dataSelectionValues><dataType>int[]</dataType><id>0</id><key>dropdown</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_CTI_PASSWORD</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_LAST_SUCCESSFUL_CTI</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_LAST_SUCCESSFUL_TFTP</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>multipleString</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_ACCEPT_VIDEO_CALLS</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">1221111</dataSelectionValues><dataType>int[]</dataType><id>0</id><key>selectioninteger</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataSelectionValues xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">123</dataSelectionValues><dataType>int[]</dataType><id>0</id><key>PresetIntegerValues</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_SUCCESS_CTI_ADDRESS</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_LAST_DEVICE_NAME</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry><entry><customAttribute><dataType>String</dataType><id>0</id><key>WEBPHONE_KEY_LAST_LINE_DN</key><resource>http://quad.cisco.com/schema/1.0/customattribute</resource><value/></customAttribute></entry></ns2:response>JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/customattributesAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/json{ "entry" : [ { "data" : { "dataSelectionValues" : [ ],"dataType" : "String[]","id" : 0,"key" : "text","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ "12345678" ],"dataType" : "int[]","id" : 0,"key" : "multivalue","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String[]","id" : 0,"key" : "test","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ "12","23","45","56","67"],"dataType" : "String[]","id" : 0,"key" : "selectiontextvalues","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_LAST_PHONE_MODE","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "int[]","id" : 0,"key" : "multiple int","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ "12" ],"dataType" : "int[]","id" : 0,"key" : "dropdown","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_CTI_PASSWORD","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_LAST_SUCCESSFUL_CTI","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_LAST_SUCCESSFUL_TFTP","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "multipleString","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_ACCEPT_VIDEO_CALLS","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ "1221111" ],"dataType" : "int[]","id" : 0,"key" : "selectioninteger","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ "123" ],"dataType" : "int[]","id" : 0,"key" : "PresetIntegerValues","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_SUCCESS_CTI_ADDRESS","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_LAST_DEVICE_NAME","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} },{ "data" : { "dataSelectionValues" : [ ],"dataType" : "String","id" : 0,"key" : "WEBPHONE_KEY_LAST_LINE_DN","resource" : "http://quad.cisco.com/schema/1.0/customattribute","value" : ""} }],"filtered" : false,"itemsPerPage" : 17,"serverMessages" : null,"sorted" : false,"startIndex" : 0,"statusCode" : 200,"totalResults" : 17}Update Custom Attributes of a User
Purpose
Updates designated custom attributes for the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
PUT
http://server[:port_number]/api/quad/rest/users/user_id/customattributes/
attributes
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to update custom attributes. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
attributes
Comma-separated string of custom attributes to be updated. To retrieve the custom attributes that you can designate here, use the operation that the "Get Information about All Custom Attributes of a User" section describes.
Request Payload
The request payload includes the following fields from the CustomAttribute resource (Table 3-12 describes these fields). You must include one pair of key and value fields for each custom attribute that you specify in the request. These key/value pairs must included in the same order as their corresponding custom attributes are specified in the request.
Response
When updating a single value, standard response (see the "API Responses" section) with an HTTP header only.
When updating multiple values, standard response with a payload that includes the status of the updates.
XML and JSON formats are supported.
XML Example
Request—Single Custom Attribute Updated
PUT http://webexsocialserver/api/quad/rest/users/110006/customattributes/DOBAccept:application/xmlContent-Type: application/xml<customAttributes><customAttribute><key>DOB</key><value>01/01/1980</value></customAttribute></customAttributes>Response—Single Custom Attribute Updated
HTTP/1.1 204 No ContentContent-Type: application/xmlRequest—Multiple Custom Attributes Updated
PUT http://webexsocialserver/api/quad/rest/users/110006/customattributes/DOB,LOCATIONAccept:application/xmlContent-Type: application/xml<customAttributes><customAttribute><key>DOB</key><value>01/01/1980</value></customAttribute><customAttribute><key>LOCATION</key><value>NewLocation</value></customAttribute></customAttributes>Response—Multiple Custom Attributes
HTTP/1.1 207 Multi-StatusContent-Type: application/xml<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:response xmlns:ns2="http://quad.cisco.com/ns/1.0/xml"><statusCode>200</statusCode><startIndex>0</startIndex><itemsPerPage>0</itemsPerPage><totalResults>0</totalResults><filtered>false</filtered><sorted>false</sorted><serverMessages><code>QUAD-600</code><description>Success</description><message>Custom attribute with key [ DOB ] is updated successfully.</message></serverMessages><serverMessages><code>QUAD-600</code><description>Success</description><message>Custom attribute with key [ LOCATION ] is updated successfully.</message></serverMessages></ns2:response>JSON Example
Request—Single Custom Attribute Updated
PUT http://webexsocialserver/api/quad/rest/users/110006/customattributes/DOBAccept:application/jsonContent-Type: application/jsonPayload:{ "customAttribute" : [ { "key" : "DOB","value" : "01/01/1980"}] }Response—Single Custom Attribute Updated
HTTP/1.1 204 No ContentContent-Type: application/jsonRequest—Multiple Custom Attributes Updated
PUT http://webexsocialserver/api/quad/rest/users/5710001/customattributes/DOB,LOCATIONAccept:application/jsonContent-Type: application/json{ "customAttribute" : [ { "key" : "DOB","value" : "01/01/1980"},{ "key" : "LOCATION","value" : "NewLocation"}] }Response—Multiple Custom Attributes Updated
HTTP/1.1 207 Multi-StatusContent-Type: application/json{ "entry" : [ ],"filtered" : false,"itemsPerPage" : 0,"serverMessages" : [ { "code" : "QUAD-600","description" : "Success","message" : "Custom attribute with key [ DOB ] is updated successfully."},{ "code" : "QUAD-600","description" : "Success","message" : "Custom attribute with key [ LOCATION ] is updated successfully."}],"sorted" : false,"startIndex" : 0,"statusCode" : 200,"totalResults" : 0}Get Information about All Activities that are Visible to You
Purpose
Retrieves information about all activities that are visible to you in Cisco WebEx Social.
An activity consists of these components: actor, action, object, and target. An activity describes an action that is performed by an actor with or on an object that relates to a target. For example, an actor could be a Cisco WebEx Social user, an action could be "created," an object could be a document, and a target could be a library.
A component may be explicit or implied. For example, an activity could be described as "Nicole updated a document in her library" or "Mike shared a post."
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/{@me|user_id}/activities
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Your user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
If filterBy equals @user, value is the identifier of a Cisco WebEx Social user. In this case, the operation retrieves only activities that are visible to you and that include this user. You can use a value of @me to designate yourself. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
If filterBy equals @community, value is the identifier of a Cisco WebEx Social community. In this case, the operation retrieves only activities that are visible to you and that include this community. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
If filterBy equals @tag, value is the name of a tag to an entity. In this case, the operation retrieves only activities that are visible to you and that include this tag.
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that includes the following:
objectType
Appears as collection.
timestamp
Date and time that the earliest activity that is returned occurred, in UTC format.
totalItems
Total number of items that are returned.
items
Array of Activity activities resources. The "Activity Activities Resource" section describes this resource.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/210018/activitiesAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Collection activities resource. For an example, see the "Collection Activities Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/210018/activitiesAccept: application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Collection activities resource. For an example, see the "Collection Activities Resource Response: Atom Format, Multiple Resources Returned" section.
Get Information about All Activities that Appears in Your Watch List
Purpose
Retrieves information about all activities that appear in your Cisco WebEx Social watch list.
An activity consists of these components: actor, action, object, and target. An activity describes an action that is performed by an actor with or on an object that relates to a target. For example, an actor could be a Cisco WebEx Social user, an action could be "created," an object could be a document, and a target could be a library.
A component may be explicit or implied. For example, an activity could be described as "Nicole updated a document in her library" or "Mike shared a post."
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/{@me|user_id}/watchlist
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Your user identifier. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that includes the following:
objectType
Appears as .
timestamp
Date and time that the earliest activity that is returned occurred, in UTC format.
totalItems
Total number of items that are returned.
items
Array of Activity activities resources. The "Activity Activities Resource" section describes this resource.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/210018/watchlistAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Collection activities resource. For an example, see the "Collection Activities Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/210018/watchlistAccept: application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Collection activities resource. For an example, see the "Collection Activities Resource Response: Atom Format, Multiple Resources Returned" section.
Get Information about all Activities that Appear in the Profile Page of a User
Purpose
Retrieves information about all activities that appear in the profile page of the designated user.
An activity consists of these components: actor, action, object, and target. An activity describes an action that is performed by an actor with or on an object that relates to a target. For example, an actor could be a Cisco WebEx Social user, an action could be "created," an object could be a document, and a target could be a library.
A component may be explicit or implied. For example, an activity could be described as "Nicole updated a document in her library" or "Mike shared a post."
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/{@me|user_id}/activities/
@profile[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve information about activities. You can use your identifier or @me to indicates yourself. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
If filterBy equals @user, value is the identifier of a Cisco WebEx Social user. In this case, the operation retrieves only activities that include this user. You can use a value of @me to designate yourself. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
If filterBy equals @community, value is the identifier of a Cisco WebEx Social community. In this case, the operation retrieves only activities that include this community. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
If filterBy equals @tag, value is the name of a tag to an entity. In this case, the operation retrieves only activities that include this tag.
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with a response payload that includes the following:
objectType
Appears as collection.
timestamp
Date and time that the earliest activity that is returned occurred, in UTC format.
totalItems
Total number of items that are returned.
items
Array of Activity activities resources. The "Activity Activities Resource" section describes this resource.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/210018/activities/@profileAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Collection activities resource. For an example, see the "Collection Activities Resource Response: JSON Format, Multiple Resources Returned" section.
Atom Example
Request
GET http://webexsocialserver/api/quad/rest/users/210018/activities/@profileAccept: application/atom+xmlResponse
HTTP/1.1 200 OKContent-Type: application/atom+xmlThe response can also include the Collection activities resource. For an example, see the "Collection Activities Resource Response: Atom Format, Multiple Resources Returned" section.
Create a Favorite Relationship for Yourself
Purpose
Creates a favorite relationship between you and a Cisco WebEx Social post.
Availability
Cisco WebEx Social 3.0 and later.
Request
POST
http://server[:port_number]/api/quad/rest/users/@me/favorite
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
The request payload includes fields from the Favorite resource (Table 3-17 describes these fields):
destination1
—
1 The destination field defines a resource that represents the post with which you have the favorite relationship. The id and the resource fields in this resource are required. Other fields are not used.
Response
Standard response (see the "API Responses" section) with a response payload that can include one Favorite resource (the "Favorite Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
POST http://webexsocialserver/api/quad/rest/users/@me/favoriteAccept:application/xmlcontent-type: xml<favorite<destination><resource>http://quad.cisco.com/schema/1.0/post</resource><id>123</id></destination></favorite>Response
HTTP/1.1 201 CreatedContent-Type: application/xmlLocation: http://webexsocialserver/api/quad/rest/users/@me/favorite/user:1234,post:500001The response can also include the Favorite resource. For an example, see the "Favorite Resource Response with Post Resource in Destination Field: XML Format, One Resource Returned" section.
JSON Example
Request
POST http://webexsocialserver/api/quad/rest/users/@me/favoriteAccept:application/jsoncontent-type: json{ "destination": {"id": "123","resource": "http://quad.cisco.com/schema/1.0/post"}}Response
HTTP/1.1 201 CreatedContent-Type: application/jsonLocation: http://webexsocialserver/api/quad/rest/users/@me/favorite/user:1234,post:500001The response can also include the Favorite resource. For an example, see the "Favorite Resource Response with Post Resource in Destination Field: JSON Format, One Resource Returned" section.
Remove a Favorite Relationship for Yourself
Purpose
Removes the designated favorite relationship in which you favorited a Cisco WebEx Social post.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
favorite_id
Identifier of the Favorite resource that defines the relationship to remove. For information about obtaining 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/users/@me/favorite/user:1234,post:500001Response
HTTP/1.1 204 No ContentCreate a Follow Relationship for Yourself
Purpose
Creates a follow relationship for yourself in which you are following another Cisco WebEx Social user.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
The request payload includes fields from the Follow resource (Table 3-19 describes these fields):
destination1
—
1 The destination field defines a resource that represents the user that you are following. The id and the resource fields in this resource are required. Other fields are not used.
Response
Standard response (see the "API Responses" section) with a response payload that can include one Follow resource (the "Follow Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
POST http://webexsocialserver/api/quad/rest/users/@me/followAccept:application/xmlContent-Type:application/xml<follow><destination><resource>http://quad.cisco.com/schema/1.0/user</resource><id>123</id></destination></follow>Response
HTTP/1.1 201 CreatedContent-Type: application/xmlLocation: http://webexsocialserver/api/quad/rest/users/@me/follow/user:1234,user:9876The response can also include the Follow resource. For an example, see the "Follow Resource Response: XML Format, One Resource Returned" section.
JSON Example
Request
POST http://webexsocialserver/api/quad/rest/users/@me/followAccept:application/jsonContent-Type:application/json{{"destination": {"id": "123","resource": "http://quad.cisco.com/schema/1.0/user"}}Response
HTTP/1.1 201 CreatedContent-Type: application/jsonLocation: http://webexsocialserver/api/quad/rest/users/@me/follow/user:1234,user:9876The response can also include the Follow resource. For an example, see the "Follow Resource Response: JSON Format, One Resource Returned" section.
Get Information about Users that are Following You
Purpose
Retrieves Follow resources that have as the destination the users that are following you.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/follow/@followersusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for detailed information about using these parameters. For this operation:
•
•
•
The sortOrder query parameter is not supported for sorting resources in a response when the filterBy query parameter is used. In this case, resources are sorted in ascending order by the fullName field in the User resource.
•
•
•
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 Follow resources (the "Follow Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/follow/@followersusersAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Follow resource. For an example, see the "Follow Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/follow/@followersusersAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Follow resource. For an example, see the "Follow Resource Response: JSON Format, Multiple Resources Returned" section.
Get the Number of Users that are Following You
Purpose
Retrieves the number of the users that are following you.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with an HTTP header only. The response includes the count of users that are following you.
Example
Request
HEAD http://webexsocialserver/api/quad/rest/users/@me/follow/@followersusersResponse
HTTP/1.1 204 No Contentx-quad-count: 2Get Information about Users that are Following the Designated User
Purpose
Retrieves Follow resources that have as the destination the users that are following the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/follow/@followersusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve Follow resources that have as the destination the users that are following this user. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for detailed information about using these parameters. For this operation:
•
•
•
The sortOrder query parameter is not supported for sorting resources in a response when the filterBy query parameter is used. In this case, resources are sorted in ascending order by the fullName field in the User resource.
•
•
•
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 Follow resources (the "Follow Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/follow/@followersusersAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Follow resource. For an example, see the "Follow Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://quadserverapi/quad/rest/users/1234/follow/@followersusersAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Follow resource. For an example, see the "Follow Resource Response: JSON Format, Multiple Resources Returned" section.
Get the Number of Users that are Following the Designated User
Purpose
Retrieves the number of users that are following the designated user.
Availability
Cisco WebEx Social 3.0 and later.
Request
HEAD
http://server[:port_number]/api/quad/rest/users/user_id/follow/@followersusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve the number of users that are following him or her. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with an HTTP header only. The response includes the count of users that are following the designated user.
Example
Request
HEAD http://webexsocialserver/api/quad/rest/users/1234/follow/@followersusersResponse
HTTP/1.1 204 No Contentx-quad-count: 2Get Information about Users that You are Following
Purpose
Retrieves Follow resources that have as the destination the users that you are following.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/follow/@followingusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for detailed information about using these parameters. For this operation:
•
•
•
The sortOrder query parameter is not supported for sorting resources in a response when the filterBy query parameter is used. In this case, resources are sorted in ascending order by the fullName field in the User resource.
•
•
•
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 Follow resources (the "Follow Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/follow/@followingusersAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Follow resource. For an example, see the "Follow Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/follow/@followingusersAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Follow resource. For an example, see the "Follow Resource Response: JSON Format, Multiple Resources Returned" section.
Get the Number of Users that You are Following
Purpose
Retrieves the number of users that you are following.
Availability
Cisco WebEx Social 3.0 and later.
Request
HEAD
http://server[:port_number]/api/quad/rest/users/@me/follow/@followingusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with an HTTP header only. The response includes the count of users that you are following.
Example
Request
HEAD http://webexsocialserver/api/quad/rest/users/@me/follow/@followingusersResponse
HTTP/1.1 204 No Contentx-quad-count: 2Get Information about Users that the Designated User is Following
Purpose
Retrieves Follow resources that have as the destination the users that the designated user is following.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/user_id/follow/@followingusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve Follow resources that have as the destination the users this user is following. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for detailed information about using these parameters. For this operation:
•
•
•
The sortOrder query parameter is not supported for sorting resources in a response when the filterBy query parameter is used. In this case, resources are sorted in ascending order by the fullName field in the User resource.
•
•
•
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 Follow resources (the "Follow Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/follow/@followingusersAccept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Follow resource. For an example, see the "Follow Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/1234/follow/@followingusersAccept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Follow resource. For an example, see the "Follow Resource Response: JSON Format, Multiple Resources Returned" section.
Get the Number of Users that the Designated User is Following
Purpose
Retrieves the number of users that the designated user is following.
Availability
Cisco WebEx Social 3.0 and later.
Request
HEAD
http://server[:port_number]/api/quad/rest/users/user_id/follow/@followingusers
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom to retrieve the number of users that he or she is following. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
A request payload is not required.
Response
Standard response (see the "API Responses" section) with an HTTP header only. The response includes the count of users that the designated user is following.
Example
Request
HEAD http://webexsocialserver/api/quad/rest/users/1234/follow/@followingusersResponse
HTTP/1.1 204 No Contentx-quad-count: 2Remove Your Following of Another Cisco WebEx Social User
Purpose
Remove the designated follow relationship in which you are following another Cisco WebEx Social user. After you execute this operation, you no longer follow the user, but the user may still be following you.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
follow_id
Identifier of the Follow resource that defines the relationship to remove. For information about obtaining 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/users/@me/follow/user:1234,user:9876Response
HTTP/1.1 204 No ContentGet Information about Users that You and the Designated User Both are Following
Purpose
Retrieves Follow resources that have as the destination the users you and a designated user both are following.
Availability
Cisco WebEx Social 3.0 and later.
Request
GET
http://server[:port_number]/api/quad/rest/users/@me/mutualfollow/
@followingusers?mutualUserId=user_id[&query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom you want to retrieve users that you both are following. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.
query_parameters
Query parameters. See the "Query Parameters" section for detailed information about using these parameters. For this operation:
•
•
•
The sortOrder query parameter is not supported for sorting resources in a response when the filterBy query parameter is used. In this case, resources are sorted in ascending order by the fullName field in the User resource.
•
•
•
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 Follow resources (the "Follow Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/mutualfollow/ @followingusers?mutualUserId=1234Accept:application/xmlResponse
HTTP/1.1 200 OKContent-Type: application/xmlThe response can also include the Follow resource. For an example, see the "Follow Resource Response: XML Format, Multiple Resources Returned" section.
JSON Example
Request
GET http://webexsocialserver/api/quad/rest/users/@me/mutualfollow/ @followingusers?mutualUserId=1234Accept:application/jsonResponse
HTTP/1.1 200 OKContent-Type: application/jsonThe response can also include the Follow resource. For an example, see the "Follow Resource Response: JSON Format, Multiple Resources Returned" section.
Get the Number of Users that You and the Designated User Both are Following
Purpose
Retrieves the number of users that you and a designated user both are following.
Availability
Cisco WebEx Social 3.0 and later.
Request
HEAD
http://server[:port_number]/api/quad/rest/users/@me/mutualfollow/
@followingusers?mutualUserId=user_id
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
user_id
Identifier of the user for whom you want to retrieve the number of users that you both are following. For information about obtaining 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. The response includes the count of users that are being followed both by you and the designated user.
Example
Request
HEAD http://webexsocialserver/api/quad/rest/users/@me/mutualfollow/ @followingusers?mutualUserId=1234Response
HTTP/1.1 204 No Contentx-quad-count: 2Create a Like Relationship for Yourself
Purpose
Creates a like relationship in which you like a Cisco WebEx Social post.
Availability
Cisco WebEx Social 3.0 and later.
Request
POST
POST http://server[:port_number]/api/quad/rest/users/@me/like
[?query_parameters]
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
query_parameters
Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:
•
•
•
•
•
•
Request Payload
The request payload includes fields from the Like resource (Table 3-21 describes these fields):
destination1
—
1 The destination field defines a resource that represents the post that you like. The id and the resource fields in this resource are required. Other fields are not used.
Response
Standard response (see the "API Responses" section) with a response payload that can include one Like resource (the "Like Relationship Resource" section describes this resource). XML and JSON formats are supported.
XML Example
Request
POST http://quadserver//api/quad/rest/users/@me/likeAccept:application/xmlContent-Type:application/xml<like><destination><resource>http://quad.cisco.com/schema/1.0/post</resource><id>123</id></destination></like>Response
HTTP/1.1 201 CreatedContent-Type: application/xmlLocation: http://webexsocialserver/api/quad/rest/users/@me/like/user:1234,post:600007The response can also include the Like resource. For an example, see the Like Resource Response with Post Resource in Destination Field: XML Format, One Resource Returned.
JSON Example
Request
POST http://quadserver//api/quad/rest/users/@me/likeAccept:application/jsonContent-Type:application/json{"destination": {"id": "123","resource": "http://quad.cisco.com/schema/1.0/post"}}Response
HTTP/1.1 201 CreatedContent-Type: application/jsonLocation: http://webexsocialserver/api/quad/rest/users/@me/like/user:1234,post:600007The response can also include the Like resource. For an example, see the Like Resource Response with Post Resource in Destination Field: JSON Format, One Resource Returned.
Remove a Like Relationship for Yourself
Purpose
Removes the designated like relationship in which you like a Cisco WebEx Social post.
Availability
Cisco WebEx Social 3.0 and later.
Request
where:
server
Host name or IP address of the Cisco WebEx Social server.
port_number
Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.
like_id
Identifier of the Like resource that defines the relationship to remove. For information about obtaining 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/users/@me/like/user:1234,post:100001Response
HTTP/1.1 204 No Content