Cisco WebEx Social API Reference Guide, Release 3.1
Index
Downloads: This chapterpdf (PDF - 479.0KB) The complete bookPDF (PDF - 16.07MB) | Feedback

Index

Table Of Contents

A - B - C - D - E - F - G - H - I - L - M - O - P - Q - R - S - T - U - V - W - X - Y -

Index

A

Accept-Encoding:gzip header 1-10

Access Token

obtaining

OAuth 1.0a 2-6

OAuth 2.0 2-13

refreshing

OAuth 1.0a 2-8

OAuth 2.0 2-14

using in request

OAuth 1.0a 2-18

OAuth 2.0 2-18

activities

definition 4-71, 4-74, 4-76, 5-63

information about, get

in a community, visible to you 5-63

in profile page 4-76

in your watch list 4-74

visible to you 4-71

activities resource

See also resource

Activity

description 3-38

fields 3-38

Attachment

description 3-40

fields 3-40

Blog

description 3-41

fields 3-41

Collection

description 3-41

fields 3-41

Comment

description 3-41

fields 3-42

Community

description 3-42

fields 3-42

description 3-37

DocumentFile

description 3-43

fields 3-43

DocumentFolder

description 3-43

fields 3-43

Event

description 3-43

fields 3-44

Media

description 3-44

fields 3-44

MediaLink

description 3-44

fields 3-45

MessageCategory

description 3-45

fields 3-46

Meta

description 3-46

fields 3-46

Permission

description 3-47

fields 3-47

Person

description 3-47

fields 3-47

Post

description 3-48

fields 3-48

Thumbnail

description 3-50

fields 3-51

Activity activities resource

description 3-38

fields 3-38

activitystrea.ms 3-37

Address resource

description 3-5

fields 3-5

API

categories

API Client resource 1-2

API Consumer resource 1-2

Community resource 1-1

Configuration 1-2

descriptions 1-1

Document Folder resource 1-1

Document resource 1-1

File resource 1-2

Membership Request resource 1-1

Mobile Client 1-2

Post resource 1-1

Search 1-2

User resource 1-1

operations

See operations

overview 1-1

request format 1-10

response, description 1-15

API client

add 14-2

definition 2-1

description 14-1

registering 2-11, 2-16

API Client resource operations

description 1-2

summary 14-1

API consumer

add 13-8

definition 2-1

description 13-1

get information about

multiple 13-5

one 13-2

registering 2-3

update 13-11

API Consumer resource operations

description 1-2, 13-1

summary 13-1

application programming interface

See API

Attachment activities resource

description 3-40

fields 3-40

Attachment resource

description 3-6

fields 3-6

attachments

add to post 7-14

delete from post 7-17

information about 7-12

authentication

OAuth 1.0a 2-2

OAuth 2.0 2-2

overview 2-1

xAuth 2-3

authorization

OAuth 1.0a 2-2

overview 2-1

authorization code

flow

overview 2-11

steps 2-11

obtaining with OAuth 2.0 2-11

B

Blog activities resource

description 3-41

fields 3-41

C

child resource 3-1

ClientAppAsset resource

description 3-7

fields 3-8

ClientAppConfig resource

description 3-8

fields 3-9

Client resource

description 3-7

fields 3-7

clients, information about, get 11-2

code of conduct, get 5-48

CodeOfConduct resource

description 3-9

fields 3-9

Collection activities resource

description 3-41

fields 3-41

comment

create 7-24

delete from post 7-29

in post, information about

all 7-21

one 7-18

update 7-27

Comment activities resource

description 3-41

fields 3-42

communities

information about 5-6

to which user belongs 4-24

to which you belong 4-22

visible on

user profile 4-28

your profile 4-26

community

add

owner to 5-26, 5-34

user group to 5-32

user to 5-18, 5-21

yourself to 5-14

create 5-8

delete 5-13

description 5-1

information about 5-4

membership requests, information about 5-45

owner, add 5-26, 5-34

posts, information about 5-50

profile images

information about 5-61

update 5-65

questions and answers, information about 5-52

remove

owner from 5-27, 5-35

user from 5-24, 5-25

user group from 5-33

yourself from 5-17

update 5-11

user, add 5-18, 5-21

user group, add 5-32

user groups, information about 5-36

users, information about 5-28, 5-30

Community activities resource

description 3-42

fields 3-42

community category

information about

multiple 5-41

one 5-39

types supported 5-43

CommunityCategory resource

description 3-11

fields 3-12

profile 3-4

Community Owner role

add to user 5-26

add to user group 5-34

remove from user 5-27, 5-35

Community resource

description 3-9

fields 3-10

operations

description 1-1, 5-1

summary 5-1

profile 3-4

CommunityType resource

description 3-12

fields 3-13, 3-15

CommunityUserGroup resource

description 3-15

profile 3-4

CommunityUser resource

description 3-13

fields 3-13

profile 3-4

Configuration

operations

description 11-1

summary 11-1

Configuration operations

description 1-2

Consumer resource

description 3-15

fields 3-15

count 1-21

custom applications, information about, get 12-4

CustomAttribute resource

description 3-16

fields 3-17

custom attributes

retrieve for user 4-60, 4-62

update for user 4-68

D

data format

Atom 1-9

description 1-9

JSON 1-9

multipart/form-data 1-9

XML 1-9

DELETE operations

community

remove

from Cisco WebEx Social     1

owner from     1, 2

user from     1, 2

user group from     1

yourself from     1

document file

all versions 8-14

designated version 8-13

document folder 9-8

favorite relationship, removing 4-81

file 10-7

follow relationship, users you are following 4-96

like relationship, for yourself 4-102

post

attachments 7-17

comment 7-29

Device resource

description 3-17

fields 3-18

DocumentFile

activities resource

description 3-43

fields 3-43

resource

description 3-18

fields 3-18

document file

delete

all versions 8-14

designated version 8-13

description 8-1

get information about

all versions 8-6

current version 8-2

designated version 8-4

update information about 8-11

upload 8-8

Document File resource operations

description 1-1, 8-1

summary 8-1

document files, get information about

in community 5-59

user

authored by in user document library 4-58

authored by in your document library 4-54

in document library 4-56

yours

community document library, in 5-57

your document library, in 4-50, 4-52

document folder

create 9-4

description 9-1

get information about 9-2

remove 9-8

update information about 9-6

DocumentFolder activities resource

description 3-43

fields 3-43

DocumentFolder resource

description 3-19

fields 3-19

Document Folder resource operations

description 1-1, 9-1

summary 9-1

document library, information about, get

for community 5-55

for user 4-48

in your document library 4-46

DocumentLibrary resource

description 3-20

fields 3-20

E

Email resource

description 3-21

fields 3-21

Entitlement resource

description 3-21

fields 3-21

Event activities resource

description 3-43

fields 3-44

F

favorite

post, of user 7-35

posts

user 4-44

yours 4-42

relationship

create 4-79

remove 4-81

Favorite resource

description 3-22

fields 3-22

favorites, user, favorite posts of 4-44

field selection 1-20

file

delete from server 10-7

get from server 10-2

upload to server 10-4

File resource

description 3-23

fields 3-23

operations

description 1-2, 10-1

summary 10-1

filter 1-20

follow relationship

count

users following user 4-89

users following you 4-86

users that a user is following 4-95

users that you and a user are following 4-99

users that you are following 4-92

create 4-82

get 4-84

remove yourself from 4-96

users

a user is following 4-93

who are following a user 4-87

you and a user are following 4-97

you are following 4-90

Follow resource

description 3-23

fields 3-24

G

GET operations

API consumer, information about 13-2

API consumers, information about 13-5

communities

information about 5-6

visible to you 5-6

community

code of conduct 5-48

information about 5-4

membership requests, information about 5-45

posts, information about 5-50

profile images, information about 5-61

questions and answers, information about 5-52

community category

information about

multiple     1

one     1

types supported 5-43

custom applications, information about 12-4

document file, information about 8-2, 8-4, 8-6

document folder, information about 9-2

file, information about 10-2

follow relationship

users a user is following 4-93

users following you 4-84

users you and a user are following 4-97

users you are following 4-90

information about

activities

in a community, visible to you     1

in profile page     1

in your watch list     1

visible to you     1

clients 11-2

communities

to which user belongs     1

to which you belong     1

visible on

user profile     1

your profile     1

custom applications 12-4

custom attributes 4-60, 4-62

document files

in community     1

user, document library, in     1, 2, 3

your

community document library, in     1

your document library, in     1, 2

document library

community     1

user     1

your     1

microposts

user     1

your     1

mobile client device type 12-2

posts

favorites

user     1

yours     1

in your library     1

recent, in your library     1

visible on

user profile     1

your profile     1

profile images

user, designated     1

your     1

user

designated     1

with designated e-mail address or screen name     1

users 4-9

yourself 4-5

membership request, information about 6-2

mobile client

device type, information about 12-2

post

attachment 7-12

comment, information about

multiple     1

one     1

information about

multiple     1

one     1

new 7-3

permissions, information about 7-30

users

who like post     1

who marked post as favorite     1

Search 15-2

user, assigned to community 5-28, 5-30

user group, assigned to community 5-36

H

header

Accept 1-10

Accept-Encoding:gzip 1-10

Content-Type 1-10

HTTP 1-16

response, description 1-16

SSO token in 1-10

HEAD operations

follow relationship, users

a user is following 4-95

following user 4-89

following you 4-86

you and a user are following 4-99

you are following 4-92

post, users who like 7-39

HTTP

header 1-16

methods 1-10

status codes 1-18

I

identifiers, of Cisco WebEx Social entities 1-11

Image resource

description 3-24

fields 3-24

implicit flow

overview 2-16

steps 2-16

index, return results 1-21

information 7-12

L

like

count of users who like post 7-39

post, by user 7-37

relationship

create for yourself 4-100

remove for yourself 4-102

Like resource

description 3-25

fields 3-25

M

Media activities resource

description 3-44

fields 3-44

MediaLink activities resource

description 3-44

fields 3-45

membership request

information about

all 5-45

one 6-2

update 6-5

MembershipRequest resource

description 3-25

fields 3-25

profile 3-4

Membership Request resource operations

description 1-1, 6-1

summary 6-1

MessageCategory activities resource

description 3-45

fields 3-46

Meta activities resource

description 3-46

fields 3-46

metadata 1-21

micropost, get

user 4-40

yours 4-38

Mobile Client

operations

description 1-2

mobile client device type, information about, get 12-2

Mobile Client operations

description 12-1

summary 12-1

model, resource 3-1

O

OAuth

See also OAuth 1.0a, OAuth 2.0

description 1-2

OAuth 1.0a

Access Token 2-6

description 2-2

flow 2-3

Request Token 2-3

verification code 2-5

OAuth 2.0

authorization code 2-11

authorization code flow, overview 2-11

description 2-2

flow

authorization code 2-11

implicit 2-16

overview 2-11

implicit flow, overview 2-16

OpenSearchDescription 15-12

operations

API Client resource

description 1-2

API Consumer resource

description 1-2, 13-1

summary 13-1

Community resource

description 1-1, 5-1

summary 5-1

Configuration

description 1-2, 11-1

summary 11-1, 14-1

Document File resource

description 1-1, 8-1

summary 8-1

Document Folder resource

description 1-1, 9-1

summary 9-1

Document resource

summary 8-1

File resource

description 1-2, 10-1

summary 10-1, 12-1

Membership Request resource

description 1-1, 6-1

summary 6-1

Mobile Client

description 1-2, 12-1

summary 12-1

Post resource

description 1-1, 7-1

summary 7-1

Search

description 1-2, 15-1

executing 15-2

query parameters

count     1

filterBy     1

overview     1

q     1

searchMetadata     1

sortBy     1

startIndex     1

startTime     1

response 15-11

summary of 1-2

User resource

description 1-1, 4-1

summary 4-1

P

pagination 1-21

payload

request, description 1-15

response

description 1-16

example

Collection activities resource     1

CommunityCategory resource     1

Community resource     1

CommunityUser resource     1

DocumentFile resource     1

DocumentFolder resource     1

DocumentLibrary resource     1

Favorite resource     1

Follow resource     1

Like resource     1

Post resource     1

ProfileImage resource     1

User resource     1

Permission activities resource

description 3-47

fields 3-47

PermissionFlags resource

description 3-27

fields 3-27

Permission resource

description 3-26

fields 3-27

permissions

for post 7-30

update for post 7-33

Person activities resource

description 3-47

fields 3-47

Phone resource

description 3-28

fields 3-28

post

attachments

add 7-14

delete 7-17

information about 7-12

comment

create 7-24

delete 7-29

information about 7-18

update 7-27

comments, information about 7-21

create 7-3

delete 7-10

description 7-1

favorite, of user 7-35

information about 7-6

like

by user 7-37

count of users who like 7-39

permissions

information about 7-30

update 7-33

update 7-10

Post activities resource

description 3-48

fields 3-48

PostComment resource

description 3-31

fields 3-32

POST operations

API client, add 14-2

API consumer, add 13-8

community

add

owner     1, 2

user     1, 2

user group     1

yourself     1

create 5-8

profile images 5-65

document file, upload 8-8

document folder, create 9-4

favorite relationship, create for you and user 4-79

file, upload 10-4

follow relationship

create, for yourself and user 4-82

users following user 4-87

like relationship, for yourself 4-100

post

attachment, add 7-14

comment, create 7-24

profile images, adding for yourself 4-20

Post resource

description 3-28

fields 3-28

operations

description 1-1, 7-1

summary 7-1

profile 3-5

posts

favorites

user 4-44

yours 4-42

get information about 5-50

information about 7-8

in your library

all, get 4-32

recent, get 4-34

visible on

user profile, get 4-36

your profile, get 4-30

ProfileImage resource

description 3-32

fields 3-32

profile images

community

information about 5-61

update 5-65

sizes 3-32, 4-20

update

user 4-18

yours 4-16

upload, for yourself 4-20

PUT operations

API consumer, update 13-11

community, update 5-11

document file, update information about 8-11

document folder, update information about 9-6

membership request 6-5

post

comment, update 7-27

information about, update 7-10

permissions, update 7-33

user

custom attributes 4-68

information 4-13

Q

query parameter

count 1-21

description 1-20

field selection 1-20

filter 1-20

index 1-21

metadata 1-21

pagination 1-21

Search operation, in 15-2

separating multiple 1-20

sort 1-20

using 1-20

query tag 15-11

QuestionAnswer resource

description 3-33

fields 3-33

Question resource

description 3-33

fields 3-33

questions and answers, information about 5-52

R

refreshing Access Token

OAuth 1.0a 2-8

OAuth 2.0 2-14

relationship

metadata 1-21

resource 3-1

request

format, API operations 1-10

formats supported 1-10

payload, description 1-15

Request Token, obtaining 2-3

resource

See also activities resource

activities

See activities resource

Address

description 3-5

fields 3-5

Attachment

description 3-6

fields 3-6

child 3-1

Client

description 3-7

fields 3-7

ClientAppAsset

description 3-7

fields 3-8

ClientAppConfig

description 3-8

fields 3-9

CodeOfConduct

description 3-9

fields 3-9

Community

description 3-9

fields 3-10

CommunityCategory

description 3-11

fields 3-12

CommunityType

description 3-12

fields 3-13, 3-15

CommunityUser

description 3-13

fields 3-13

CommunityUserGroup

description 3-15

Consumer

description 3-15

fields 3-15

CustomAttribute

description 3-16

fields 3-17

description 1-9, 3-1

Device

description 3-17

fields 3-18

DocumentFile

description 3-18

fields 3-18

DocumentFolder

description 3-19

fields 3-19

DocumentLibrary

description 3-20

fields 3-20

Email

description 3-21

fields 3-21

Entitlement

description 3-21

fields 3-21

Favorite

description 3-22

fields 3-22

File

description 3-23

fields 3-23

Follow

description 3-23

fields 3-24

general 3-1

Image

description 3-24

fields 3-24

Like

description 3-25

fields 3-25

MembershipRequest

description 3-25

fields 3-25

model 3-1

Permission

description 3-26

fields 3-27

PermissionFlags

description 3-27

fields 3-27

Phone

description 3-28

fields 3-28

Post

description 3-28

fields 3-28

PostComment

description 3-31

fields 3-32

profile 3-3

ProfileImage

description 3-32

fields 3-32

Question

description 3-33

fields 3-33

QuestionAnswer

description 3-33

fields 3-33

relationship 3-1

Role

description 3-33

fields 3-34

Tags

description 3-34

fields 3-34

User

description 3-34

fields 3-34

response

description 1-15

header, description 1-16

payload

description 1-16

example

Collection activities resource     1

CommunityCategory resource     1

Community resource     1

CommunityUser resource     1

DocumentFile resource     1

DocumentFolder resource     1

DocumentLibrary resource     1

Favorite resource     1

Follow resource     1

Like resource     1

Post resource     1

ProfileImage resource     1

User resource     1

Role resource

description 3-33

fields 3-34

S

Search operation

description 1-2, 15-1

executing 15-2

query parameters

count 15-10

filterBy 15-8

overview 15-2

q 15-2

searchMetadata 15-9

sortBy 15-9

startIndex 15-10

startTime 15-10

query tag 15-11

response 15-11

server messages 1-19

sort 1-20

SSO token 1-10

status codes, HTTP 1-18

T

Tags resource

description 3-34

fields 3-34

Thumbnail activities resource

description 3-50

fields 3-51

trusted

application 2-3

device 2-3

U

user

assign Community Owner role 5-26

get information about

all 4-9

designated 4-7

for email address or screen name 4-11

update information about 4-13, 4-68

user group

add to community 5-32

assign Community Owner role 5-34

owner role

add 5-34

remove 5-35

remove from community 5-33

User resource

description 3-34

fields 3-34

operations

description 1-1, 4-1

summary 4-1

profile 3-5

V

verification code 2-5

W

watch list, get activities in you 4-74

X

xAuth

description 1-2, 2-3

using with trusted clients 2-18

Y

yourself

community

add to 5-14, 5-18, 5-21

remove from 5-17, 5-24, 5-25

favorite relationship

create 4-79

remove 4-81

follow relationship, create 4-82

information about, get 4-5

like relationship

create 4-100

remove 4-102

profile images, add 4-20