Cisco WebEx Social API Reference Guide, Release 3.0
Index
Downloads: This chapterpdf (PDF - 442.0KB) The complete bookPDF (PDF - 14.42MB) | 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-9

Access Token

obtaining 2-6

refreshing 2-8

using in request 2-10

activities

definition 4-72, 4-75, 4-77, 5-64

information about, get

in a community, visible to you 5-64

in profile page 4-77

in your watch list 4-75

visible to you 4-72

activities resource

See also resource

Activity

description 3-32

fields 3-33

Attachment

description 3-34

fields 3-35

Blog

description 3-35

fields 3-35

Collection

description 3-35

fields 3-35

Comment

description 3-36

fields 3-36

Community

description 3-36

fields 3-37

description 3-31

DocumentFile

description 3-37

fields 3-37

DocumentFolder

description 3-37

fields 3-38

Event

description 3-38

fields 3-38

Media

description 3-38

fields 3-38

MediaLink

description 3-39

fields 3-39

MessageCategory

description 3-40

fields 3-40

Meta

description 3-41

fields 3-41

Permission

description 3-41

fields 3-42

Person

description 3-42

fields 3-42

Post

description 3-43

fields 3-43

Thumbnail

description 3-45

fields 3-45

Activity activities resource

description 3-32

fields 3-33

activitystrea.ms 3-31

Address resource

description 3-5

fields 3-5

API

categories

API Consumer resource 1-2

Community resource 1-1

descriptions 1-1

Document Folder resource 1-1

Document resource 1-1

File resource 1-2

Membership Request resource 1-1

Post resource 1-1

Search 1-2

User resource 1-1

operations

See operations

overview 1-1

request format 1-9

response, description 1-14

API consumer

add 11-8

description 11-1

get information about

multiple 11-5

one 11-2

registering 2-3

update 11-11

API Consumer resource operations

description 1-2, 11-1

summary 11-1

application programming interface

See API

Attachment activities resource

description 3-34

fields 3-35

Attachment resource

description 3-5

fields 3-5

attachments

add to post 7-15

delete from post 7-18

information about 7-12

authentication

OAuth 1a 2-2

overview 2-1

xAuth 2-2

authorization

OAuth 1a 2-2

overview 2-1

B

Blog activities resource

description 3-35

fields 3-35

C

child resource 3-1

code of conduct, get 5-48

CodeOfConduct resource

description 3-6

fields 3-6

Collection activities resource

description 3-35

fields 3-35

comment

create 7-25

delete from post 7-30

in post, information about

all 7-22

one 7-19

update 7-28

Comment activities resource

description 3-36

fields 3-36

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-62

update 5-67

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-36

fields 3-37

community category

information about

multiple 5-41

one 5-39

types supported 5-43

CommunityCategory resource

description 3-8

fields 3-9

profile 3-3

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-6

fields 3-7

operations

description 1-1, 5-1

summary 5-1

profile 3-3

CommunityType resource

description 3-9

fields 3-10, 3-12

CommunityUserGroup resource

description 3-12

profile 3-4

CommunityUser resource

description 3-10

fields 3-10

profile 3-4

Consumer resource

description 3-12

fields 3-12

count 1-20

CustomAttribute resource

description 3-13

fields 3-14

custom attributes

retrieve for user 4-61, 4-63

update for user 4-69

D

data format

Atom 1-8

description 1-8

JSON 1-8

multipart/form-data 1-9

XML 1-8

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-82

file 10-7

follow relationship, users you are following 4-99

like relationship, for yourself 4-106

post

attachments 7-18

comment 7-30

DocumentFile

activities resource

description 3-37

fields 3-37

resource

description 3-14

fields 3-14

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-37

fields 3-38

DocumentFolder resource

description 3-15

fields 3-16

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-16

fields 3-16

E

Email resource

description 3-17

fields 3-17

Event activities resource

description 3-38

fields 3-38

F

favorite

post, of user 7-36

posts

user 4-44

yours 4-42

relationship

create 4-80

remove 4-82

Favorite resource

description 3-17

fields 3-17

favorites, user, favorite posts of 4-44

field selection 1-19

file

delete from server 10-7

get from server 10-2

upload to server 10-4

File resource

description 3-18

fields 3-18

operations

description 1-2, 10-1

summary 10-1

filter 1-19

follow relationship

count

users following user 4-91

users following you 4-87

users that a user is following 4-98

users that you and a user are following 4-103

users you are following 4-94

create 4-83

get 4-85

remove yourself from 4-99

users

a user is following 4-95

who are following a user 4-88

you and a user are following 4-100

you are following 4-92

Follow resource

description 3-18

fields 3-19

G

GET operations

API consumer, information about 11-2

API consumers, information about 11-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-62

questions and answers, information about 5-52

community category

information about

multiple     1

one     1

types supported 5-43

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-95

users following you 4-85

users you and a user are following 4-100

users you are following 4-92

information about

activities

in a community, visible to you     1

in profile page     1

in your watch list     1

visible to you     1

communities

to which user belongs     1

to which you belong     1

visible on

user profile     1

your profile     1

custom attributes 4-61, 4-63

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

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

post

attachment 7-12

comment, information about

multiple     1

one     1

information about

multiple     1

one     1

new 7-3

permissions, information about 7-31

users

who like post     1

who marked post as favorite     1

Search 12-2

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

user group, assigned to community 5-36

H

header

Accept 1-9

Accept-Encoding:gzip 1-9

Content-Type 1-9

HTTP 1-15

response, description 1-15

SSO token in 1-9

HEAD operations

follow relationship, users

a user is following 4-98

following user 4-91

following you 4-87

you and a user are following 4-103

you are following 4-94

post, users who like 7-40

HTTP

header 1-15

methods 1-9

status codes 1-17

I

identifiers, of Cisco WebEx Social entities 1-10

Image resource

description 3-19

fields 3-19

index, return results 1-20

information 7-12

L

like

count of users who like post 7-40

post, by user 7-38

relationship

create for yourself 4-104

remove for yourself 4-106

Like resource

description 3-20

fields 3-20

M

Media activities resource

description 3-38

fields 3-38

MediaLink activities resource

description 3-39

fields 3-39

membership request

information about

all 5-45

one 6-2

update 6-5

MembershipRequest resource

description 3-20

fields 3-20

profile 3-4

Membership Request resource operations

description 1-1, 6-1

summary 6-1

MessageCategory activities resource

description 3-40

fields 3-40

Meta activities resource

description 3-41

fields 3-41

metadata 1-21

micropost, get

user 4-40

yours 4-38

model, resource 3-1

O

OAuth

Access Token 2-6

description 1-2, 2-2

flow 2-2

refreshing Access Token 2-8

Request Token 2-3

verification code 2-5

OpenSearchDescription 12-12

operations

API Consumer resource

description 1-2, 11-1

summary 11-1

Community resource

description 1-1, 5-1

summary 5-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

Membership Request resource

description 1-1, 6-1

summary 6-1

Post resource

description 1-1, 7-1

summary 7-1

Search

description 1-2, 12-1

executing 12-2

query parameters

count     1

filterBy     1

overview     1

q     1

searchMetadata     1

sortBy     1

startIndex     1

startTime     1

response 12-11

summary of 1-2

User resource

description 1-1, 4-1

summary 4-1

P

pagination 1-20

payload

request, description 1-14

response

description 1-15

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-41

fields 3-42

PermissionFlags resource

description 3-22

fields 3-22

Permission resource

description 3-21

fields 3-22

permissions

for post 7-31

update for post 7-34

Person activities resource

description 3-42

fields 3-42

Phone resource

description 3-23

fields 3-23

post

attachments

add 7-15

delete 7-18

information about 7-12

comment

create 7-25

delete 7-30

information about 7-19

update 7-28

comments, information about 7-22

create 7-3

delete 7-10

description 7-1

favorite, of user 7-36

information about 7-6

like

by user 7-38

count of users who like 7-40

permissions

information about 7-31

update 7-34

update 7-10

Post activities resource

description 3-43

fields 3-43

PostComment resource

description 3-26

fields 3-27

POST operations

API consumer, add 11-8

community

add

owner     1, 2

user     1, 2

user group     1

yourself     1

create 5-8

profile images 5-67

document file, upload 8-8

document folder, create 9-4

favorite relationship, create for you and user 4-80

file, upload 10-4

follow relationship

create, for yourself and user 4-83

users following user 4-88

like relationship, for yourself 4-104

post

attachment, add 7-15

comment, create 7-25

profile images, adding for yourself 4-20

Post resource

description 3-23

fields 3-23

operations

description 1-1, 7-1

summary 7-1

profile 3-4

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-27

fields 3-27

profile images

community

information about 5-62

update 5-67

sizes 3-27, 4-20

update

user 4-18

yours 4-16

upload, for yourself 4-20

PUT operations

API consumer, update 11-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-28

information about, update 7-10

permissions, update 7-34

user

custom attributes 4-69

information 4-13

Q

query parameter

count 1-20

description 1-19

field selection 1-19

filter 1-19

index 1-20

metadata 1-21

pagination 1-20

Search operation, in 12-2

separating multiple 1-19

sort 1-20

using 1-19

query tag 12-11

QuestionAnswer resource

description 3-28

fields 3-28

Question resource

description 3-28

fields 3-28

questions and answers, information about 5-52

R

relationship

metadata 1-21

resource 3-1

request

format, API operations 1-9

formats supported 1-9

payload, description 1-14

Request Token, obtaining 2-3

resource

See also activities resource

activities

See activities resource

Address

description 3-5

fields 3-5

Attachment

description 3-5

fields 3-5

child 3-1

CodeOfConduct

description 3-6

fields 3-6

Community

description 3-6

fields 3-7

CommunityCategory

description 3-8

fields 3-9

CommunityType

description 3-9

fields 3-10, 3-12

CommunityUser

description 3-10

fields 3-10

CommunityUserGroup

description 3-12

Consumer

description 3-12

fields 3-12

CustomAttribute

description 3-13

fields 3-14

description 1-8, 3-1

DocumentFile

description 3-14

fields 3-14

DocumentFolder

description 3-15

fields 3-16

DocumentLibrary

description 3-16

fields 3-16

Email

description 3-17

fields 3-17

Favorite

description 3-17

fields 3-17

File

description 3-18

fields 3-18

Follow

description 3-18

fields 3-19

general 3-1

Image

description 3-19

fields 3-19

Like

description 3-20

fields 3-20

MembershipRequest

description 3-20

fields 3-20

model 3-1

Permission

description 3-21

fields 3-22

PermissionFlags

description 3-22

fields 3-22

Phone

description 3-23

fields 3-23

Post

description 3-23

fields 3-23

PostComment

description 3-26

fields 3-27

profile 3-3

ProfileImage

description 3-27

fields 3-27

Question

description 3-28

fields 3-28

QuestionAnswer

description 3-28

fields 3-28

relationship 3-1

Role

description 3-28

fields 3-29

Tags

description 3-29

fields 3-29

User

description 3-29

fields 3-29

response

description 1-14

header, description 1-15

payload

description 1-15

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-28

fields 3-29

S

Search operation

description 1-2, 12-1

executing 12-2

query parameters

count 12-11

filterBy 12-8

overview 12-2

q 12-3

searchMetadata 12-10

sortBy 12-9

startIndex 12-10

startTime 12-11

query tag 12-11

response 12-11

server messages 1-18

sort 1-20

SSO token 1-9

status codes, HTTP 1-17

T

Tags resource

description 3-29

fields 3-29

Thumbnail activities resource

description 3-45

fields 3-45

trusted

application 2-2

device 2-2

U

user

assign Community Owner role 5-26

description 3-1, 4-1

get information about

all 4-9

designated 4-7

for email address or screen name 4-11

update information about 4-13, 4-69

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-29

fields 3-29

operations

description 1-1, 4-1

summary 4-1

profile 3-4

V

verification code 2-5

W

watch list, get activities in you 4-75

X

xAuth

description 1-2, 2-2

using with trusted clients 2-11

Y

yourself

community

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

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

favorite relationship

create 4-80

remove 4-82

follow relationship, create 4-83

information about, get 4-5

like relationship

create 4-104

remove 4-106

profile images, add 4-20