Cisco WebEx Social API Reference Guide, Release 3.4
Preface
Downloads: This chapterpdf (PDF - 191.0KB) The complete bookPDF (PDF - 15.05MB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Command Syntax Conventions

Obtaining Documentation, Obtaining Support, and Security Guidelines


Preface


This document provides information that is required to understand and use the Cisco WebEx Social release 3.4 RESTful application programming interface (API).

Audience

This document is intended for developers who want to use the Cisco WebEx Social API to control various Cisco WebEx Social features and functions and to access Cisco WebEx Social resources and data. It assumes that developers have knowledge or experience with Cisco WebEx Social, a web-level programming language, and the following:

Representational state transfer (REST) architecture

JavaScript Object Notation (JSON)

Web services

Hyper Text Transport Protocol (HTTP) and Secure HTTP (HTTPS)

Organization

This document is organized as follows:

Chapter 1 "Introduction to the Cisco WebEx Social API"

Provides an overview of the Cisco WebEx Social API and provides general information that applies to the API operations

Chapter 2 "Authorization and Authentication"

Describes how the API uses the OAuth and xAuth protocols for authorization and authentication

Chapter 3 "Resources"

Describes the resources that are used in Cisco WebEx social API operations

Chapter 4 "User Resource Operations"

Provides detailed descriptions of the User resource operations

Chapter 5 "User Group Resource Operations"

Provides detailed descriptions of the User Group resource operations

Chapter 6 "Community Resource Operations"

Provides detailed descriptions of the Community resource operations

Chapter 7 "Membership Request Resource Operations"

Provides detailed descriptions of the Membership request Resource operations

Chapter 8 "Post Resource Operations"

Provides detailed descriptions of the Post resource operations

Chapter 9 "Tags Resource and TagTrends Resource Operations"

Provides detailed descriptions of the Tags resource operations

Chapter 10 "Suggestions Resource Operations"

Provides detailed descriptions of the Suggestions resource operations

Chapter 11 "Document File Resource Operations"

Provides detailed descriptions of the Document File resource operations

Chapter 12 "Document Folder Resource Operations"

Provides detailed descriptions of the Document Folder resource operations

Chapter 13 "File Resource Operations"

Provides detailed descriptions of the File resource operations

Chapter 14 "Configuration Operations"

Provides detailed descriptions of the Video Providers resource operations, Portal Settings resource operation, Entitlement resource operation, and Eula resource operation

Chapter 15 "Mobile Client Operations"

Provides detailed descriptions of the Mobile Client operations

Chapter 16 "API Consumer Resource Operations"

Provides detailed descriptions of the API Consumer resource operations

Chapter 17 "API Client Resource Operation"

Provides detailed description of the API Client resource operation

Chapter 18 "Search Operation"

Provides a detailed description of the Search operations

Chapter 19 "Response Examples"

Provides examples of API responses for operations that return User, Community, CommunityCategory, Post, or relationship resources in the response payload


Command Syntax Conventions

describes the syntax that this document uses for API operations.

Table 1 Command Syntax Guide

Convention
Description

bold text

Bold text indicates text that must be entered as shown.

italic text

Italic text indicates a variable that you must replace with the appropriate value.

[ ]

Brackets in regular type indicate optional text. Do not include the brackets when entering the command.

Brackets in bold type must be entered.

{ }

Braces indicate two or more mutually exclusive items, where each item is separated by a vertical bar (|) and one item is required. Do not include the braces or vertical bar when entering the command.

|

A vertical bar separates each item in a set of two or more mutually exclusive items, where one item is required.

screen text

Screen text indicates examples of command input or output.


Obtaining Documentation, Obtaining Support, and Security Guidelines

For information about obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation. This publication also lists new and revised Cisco technical documentation. It is available at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html