Cisco WebEx Social API Reference Guide, Release 3.3
Index
Downloads: This chapterpdf (PDF - 668.0KB) The complete bookPDF (PDF - 14.25MB) | 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-12

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-66, 4-70, 4-72, 5-59, 7-41

information about, get

in a community, visible to you 5-59

in profile page 4-72

in your watch list 4-70

related to post 7-41

visible to you 4-66

activities resource

See also resource

Activity

description 3-48

fields 3-48

Attachment

description 3-50

fields 3-50

Blog

description 3-51

fields 3-51

Collection

description 3-51

fields 3-51

Comment

description 3-51

fields 3-52

Community

description 3-52

fields 3-52

description 3-46

DocumentFile

description 3-53

fields 3-53

DocumentFolder

description 3-53

fields 3-53

Event

description 3-53

fields 3-54

Media

description 3-54

fields 3-54

MediaLink

description 3-54

fields 3-55

MessageCategory

description 3-55

fields 3-56

Meta

description 3-56

fields 3-56

Permission

description 3-57

fields 3-57

Person

description 3-57

fields 3-57

Post

description 3-58

fields 3-58

Thumbnail

description 3-61

fields 3-61

Activity activities resource

description 3-48

fields 3-48

activitystrea.ms 3-47

Address resource

description 3-6

fields 3-6

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

Document resource 1-2

Entitlement resource 1-2

Eula resource 1-2

File resource 1-2

Membership Request resource 1-1

Mobile Client 1-2

Portal Settings resource 1-2

Post resource 1-1

Search 1-2

Suggestions resource 1-2

Tags resource 1-1

TagTrends resource 1-1

User resource 1-1

Video Providers resource 1-2

operations

See operations

overview 1-1

request format 1-11

response, description 1-17

API client

add 16-2

definition 2-1

description 16-1

registering 2-11, 2-16

API Client resource operations

description 1-2, 16-1

summary 16-1

API consumer

add 15-6

definition 2-1

description 15-1

get information about

multiple 15-4

one 15-2

registering 2-3

update 15-8

API Consumer resource operations

description 1-2, 15-1

summary 15-1

application programming interface

See API

attached video

delete from micropost 7-31

description 3-24

in post, information about 7-26

Attachment activities resource

description 3-50

fields 3-50

Attachment resource

description 3-7

fields 3-7

attachments

add to post 7-13

delete from post 7-15

information about 7-11

Audience xv

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

fields 3-51

C

child resource 3-1

ClientAppAsset resource

description 3-8

fields 3-8

ClientAppConfig resource

description 3-9

fields 3-9

Client resource

description 3-7

fields 3-7

clients, information about, get 13-12, 13-15

code of conduct, get 5-63

CodeOfConduct resource

description 3-10

fields 3-10

Collection activities resource

description 3-51

fields 3-51

command

conventions xvi

syntax xvi

comment

create 7-20

delete from post 7-23

in post, information about

all 7-18

one 7-16

update 7-22

Comment activities resource

description 3-51

fields 3-52

communities

information about 5-6

to which user belongs 4-23

to which you belong 4-21

visible on

user profile 4-27

your profile 4-25

community

add

owner to 5-22, 5-30

user group to 5-28

user to 5-16, 5-18

yourself to 5-13

create 5-8

delete 5-12

description 5-1

information about 5-4

membership requests, information about 5-40

owner, add 5-22, 5-30

posts, information about 5-42

profile images

information about 5-56

update 5-58

questions and answers, information about 5-44

remove

owner from 5-23, 5-31

user from 5-20, 5-21

user group from 5-29

yourself from 5-15

update 5-10

update information about 5-54

user, add 5-16, 5-18

user group, add 5-28

user groups, information about 5-32

users, information about 5-24, 5-26

Community activities resource

description 3-52

fields 3-52

community category

information about

multiple 5-36

one 5-34

types supported 5-38

CommunityCategory resource

description 3-13

fields 3-13

profile 3-4

CommunityMetrics resource

description 3-14

fields 3-14

Community Owner role

add to user 5-22

add to user group 5-30

remove from user 5-23, 5-31

Community resource

description 3-10

fields 3-11

operations

description 1-1, 5-1

summary 5-1

profile 3-4

CommunityType resource

description 3-15

fields 3-15

CommunityUserGroup resource

description 3-17

fields 3-17

profile 3-5

CommunityUser resource

description 3-15

fields 3-15

profile 3-5

configuration operations

description 1-2, 13-1

Entitlement resource 13-1, 13-11

Eula resource 13-1, 13-14

Portal resource 13-1, 13-9

Video Provide resource 13-1, 13-2

Consumer resource

description 3-17

fields 3-18

conventions, command xvi

count 1-22

custom applications, information about, get 14-4

CustomAttribute resource

description 3-19

fields 3-19

custom attributes

retrieve

for community 5-52

for user 4-59, 4-61

update

for community 5-54

for user 4-64

D

data format

Atom 1-11

description 1-11

JSON 1-11

multipart/form-data 1-11

XML 1-11

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 10-13

designated version 10-12

document folder 11-7

favorite relationship, removing 4-76

file 12-6

follow relationship, users you are following 4-91

like relationship, for yourself 4-97

micropost, attached video 7-31

post

attachments 7-15

comment 7-23

suggestions, stop providing 9-10

tag

from Cisco WebEx Social 8-10

from post 7-25

video providers 13-8

Device resource

description 3-20

fields 3-20

DiscussionForumCategory resource

description 3-20

fields 3-21

DocumentFile

activities resource

description 3-53

fields 3-53

resource

description 3-22

fields 3-22

document file

delete

all versions 10-13

designated version 10-12

description 10-1

get information about

all versions 10-6

current version 10-2

designated version 10-4

update information about 10-10

upload 10-8

Document File resource operations

description 1-2, 10-1

summary 10-1

document files, get information about

in community 5-50

user

authored by in user document library 4-57

authored by in your document library 4-53

in document library 4-55

yours

community document library, in 5-48

your document library, in 4-49, 4-51

document folder

create 11-4

description 11-1

get information about 11-2

remove 11-7

update information about 11-6

DocumentFolder activities resource

description 3-53

fields 3-53

DocumentFolder resource

description 3-23

fields 3-23

Document Folder resource operations

description 1-2, 11-1

summary 11-1

document library, information about, get

for community 5-46

for user 4-47

in your document library 4-45

DocumentLibrary resource

description 3-23

fields 3-24

E

Email resource

description 3-24

fields 3-24

embedded video

definition 3-24

in micropost, information about 7-26

EmbeddedVideo resource

description 3-24

fields 3-25

end user license agreement (EULA) 3-27, 13-14

Entitlement resource

description 3-25

fields 3-26

operation

description 1-2, 13-11

summary 13-11

Eula resource

description 3-27

fields 3-27

operation

description 1-2, 13-14

summary 13-14

Event activities resource

description 3-53

fields 3-54

F

favorite

post, of user 7-36

posts

user 4-43

yours 4-41

relationship

create 4-74

remove 4-76

Favorite resource

description 3-28

fields 3-28

favorites, user, favorite posts of 4-43

field selection 1-21

file

delete from server 12-6

get from server 12-2

upload to server 12-4

File resource

description 3-28

fields 3-28

operations

description 1-2, 12-1

summary 12-1

filter 1-21

follow relationship

count

users following user 4-84

users following you 4-81

users that a user is following 4-90

users that you and a user are following 4-94

users that you are following 4-87

create 4-77

get 4-79

remove yourself from 4-91

users

a user is following 4-88

who are following a user 4-82

you and a user are following 4-92

you are following 4-85

Follow resource

description 3-29

fields 3-29

G

GET operations

API consumer, information about 15-2

API consumers, information about 15-4

communities

information about 5-6

visible to you 5-6

community

code of conduct 5-63

information about 5-4

membership requests, information about 5-40

metrics 5-61

posts, information about 5-42

profile images, information about 5-56

questions and answers, information about 5-44

community category

information about

multiple     1

one     1

types supported 5-38

custom applications, information about 14-4

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

document folder, information about 11-2

file, information about 12-2

follow relationship

users a user is following 4-88

users following you 4-79

users you and a user are following 4-92

users you are following 4-85

information about

activities

in a community, visible to you     1

in profile page     1

in your watch list     1

related to post     1

visible to you     1

clients 13-12, 13-15

communities

to which user belongs     1

to which you belong     1

visible on

user profile     1

your profile     1

custom applications 14-4

custom attributes 4-61

community     1

user     1

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 14-2

portal settings 13-10

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

tags

applied to a post     1

most common     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

micropost, attached video, information about 7-26

mobile client, device type, information about 14-2

post

attachment 7-11

comment, information about

multiple     1

one     1

embedded video, information about 7-26

information about

multiple     1

one     1

permissions, information about 7-32

users

who like post     1

who marked post as favorite     1

Search 17-2

suggestions

communities to join 9-6

people, communities, and posts 9-2

people to follow 9-4

posts to read 9-8

tags, information about 8-3

user, assigned to community 5-24, 5-26

user group, assigned to community 5-32

video provider, information about 13-3

H

header

Accept 1-11

Accept-Encoding:gzip 1-12

Content-Type 1-11

HTTP 1-17

response, description 1-17

SSO token in 1-12

HEAD operations

follow relationship, users

a user is following 4-90

following user 4-84

following you 4-81

you and a user are following 4-94

you are following 4-87

post, users who like 7-40

HTTP

header 1-17

methods 1-12

status codes 1-19

I

identifiers, of Cisco WebEx Social entities 1-12

Image resource

description 3-29

fields 3-29

implicit flow, steps 2-16

index, return results 1-21

information 7-11

L

like

count of users who like post 7-40

post, by user 7-38

relationship

create for yourself 4-95

remove for yourself 4-97

Like resource

description 3-30

fields 3-30

M

Media activities resource

description 3-54

fields 3-54

MediaLink activities resource

description 3-54

fields 3-55

membership request

information about

all 5-40

one 6-2

update 6-4

MembershipRequest resource

description 3-30

fields 3-30

profile 3-5

Membership Request resource operations

description 1-1, 6-1

summary 6-1

MessageCategory activities resource

description 3-55

fields 3-56

Meta activities resource

description 3-56

fields 3-56

metadata 1-22

metrics, get 5-61

micropost

attached video, delete 7-31

embedded video, information about 7-26

get

user 4-39

yours 4-37

video, attach 7-28

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

Mobile Client operations

description 1-2, 14-1

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

OpenSearchDescription 17-12

operations

API Client resource

description 1-2, 16-1

summary 16-1

API Consumer resource

description 1-2, 15-1

summary 15-1

Community resource

description 1-1, 5-1

summary 5-1

configuration

description 1-2, 13-1

Entitlement resource 13-1, 13-11

Eula resource 13-1, 13-14

Portal resource 13-1, 13-9

Video Providers resource 13-1, 13-2

Document File resource

description 1-2, 10-1

summary 10-1

Document Folder resource

description 1-2, 11-1

summary 11-1

Entitlement resource

description 1-2

summary 13-11

Eula resource

description 1-2, 13-14

summary 13-14

File resource

description 1-2, 12-1

summary 12-1, 14-1

Membership Request resource

description 1-1, 6-1

summary 6-1

Mobile Client

description 1-2, 14-1

summary 14-1

Portal Settings resource

description 1-2, 13-9

summary 13-9

Post resource

description 1-1, 7-1

summary 7-1

Search

description 1-2, 17-1

executing 17-2

query parameters

count     1

filterBy     1

overview     1

q     1

searchMetadata     1

sortBy     1

startIndex     1

startTime     1

response 17-11

Suggestions resource

description 1-2, 9-1

summary 9-1

summary of 1-2

Tags resource

description 1-1, 8-1

summary 8-1

TagTrends resource

description 1-1, 8-1

summary 8-2

User resource

description 1-1, 4-1

summary 4-1

Video Providers resource

description 1-2

summary 13-2

P

pagination 1-21

payload

request, description 1-17

response

description 1-18

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

Suggestions resource     1

User resource     1

Permission activities resource

description 3-57

fields 3-57

PermissionFlags resource

description 3-32

fields 3-32

Permission resource

description 3-31

fields 3-32

permissions

for post 7-32

update for post 7-34

Person activities resource

description 3-57

fields 3-57

Phone resource

description 3-33

fields 3-33

portal settings, information about 13-10

PortalSettings resource

description 3-33

fields 3-33

Portal Settings resource operation

description 1-2, 13-9

summary 13-9

post

attached video

information about 7-26

update 7-30

attachments

add 7-13

delete 7-15

information about 7-11

comment

create 7-20

delete 7-23

information about 7-16

update 7-22

comments, information about 7-18

create 7-3

delete 7-9

description 7-1

favorite, of user 7-36

information about 7-5

like

by user 7-38

count of users who like 7-40

permissions

information about 7-32

update 7-34

update 7-9

Post activities resource

description 3-58

fields 3-58

PostComment resource

description 3-38

fields 3-38

POST operations

API client, add 16-2

API consumer, add 15-6

community

add

owner     1, 2

user     1, 2

user group     1

yourself     1

create 5-8

profile images 5-58

document file, upload 10-8

document folder, create 11-4

favorite relationship, create for you and user 4-74

file, upload 12-4

follow relationship

create, for yourself and user 4-77

users following user 4-82

like relationship, for yourself 4-95

micropost, video, attach 7-28

post

attachment, add 7-13

comment, create 7-20

new 7-3

profile images, adding for yourself 4-19

tag

add to post 7-24

new 8-7

video provider, add to white list 13-5

Post resource

description 3-33

fields 3-34

operations

description 1-1, 7-1

summary 7-1

profile 3-5

posts

favorites

user 4-43

yours 4-41

get information about 5-42

information about 7-7

in your library

all, get 4-31

recent, get 4-33

visible on

user profile, get 4-35

your profile, get 4-29

ProfileImage resource

description 3-39

fields 3-39

profile images

community

information about 5-56

update 5-58

sizes 3-39, 4-19

update

user 4-17

yours 4-15

upload, for yourself 4-19

PUT operations

API consumer, update 15-8

attached video, update 7-30

community

custom attributes 5-54

update 5-10

document file, update information about 10-10

document folder, update information about 11-6

membership request 6-4

post

comment, update 7-22

information about, update 7-9

permissions, update 7-34

tag, update name 8-9

user

custom attributes 4-64

information 4-13

video provider, update information about 13-7

Q

query parameter

count 1-22

description 1-20

field selection 1-21

filter 1-21

index 1-21

metadata 1-22

pagination 1-21

Search operation, in 17-2

separating multiple 1-21

sort 1-21

using 1-21

query tag 17-11

QuestionAnswer resource

description 3-40

fields 3-40

Question resource

description 3-39

fields 3-39

questions and answers, information about 5-44

R

refreshing Access Token

OAuth 1.0a 2-8

OAuth 2.0 2-14

relationship

metadata 1-22

resource 3-1

request

format, API operations 1-11

formats supported 1-11

payload, description 1-17

Request Token, obtaining 2-3

resource

See also activities resource

activities

See activities resource

Address

description 3-6

fields 3-6

Attachment

description 3-7

fields 3-7

child 3-1

Client

description 3-7

fields 3-7

ClientAppAsset

description 3-8

fields 3-8

ClientAppConfig

description 3-9

fields 3-9

CodeOfConduct

description 3-10

fields 3-10

Community

description 3-10

fields 3-11

CommunityCategory

description 3-13

fields 3-13

CommunityMetrics

description 3-14

fields 3-14

CommunityType

description 3-15

fields 3-15

CommunityUser

description 3-15

fields 3-15

CommunityUserGroup

description 3-17

fields 3-17

Consumer

description 3-17

fields 3-18

CustomAttribute

description 3-19

fields 3-19

description 1-11, 3-1

Device

description 3-20

fields 3-20

DiscussionForumCategory

description 3-20

fields 3-21

DocumentFile

description 3-22

fields 3-22

DocumentFolder

description 3-23

fields 3-23

DocumentLibrary

description 3-23

fields 3-24

Email

description 3-24

fields 3-24

EmbeddedVideo

description 3-24

fields 3-25

Entitlement

description 3-25

fields 3-26

Eula

description 3-27

fields 3-27

Favorite

description 3-28

fields 3-28

File

description 3-28

fields 3-28

Follow

description 3-29

fields 3-29

general 3-1

Image

description 3-29

fields 3-29

Like

description 3-30

fields 3-30

MembershipRequest

description 3-30

fields 3-30

model 3-1

Permission

description 3-31

fields 3-32

PermissionFlags

description 3-32

fields 3-32

Phone

description 3-33

fields 3-33

PortalSettings

description 3-33

fields 3-33

Post

description 3-33

fields 3-34

PostComment

description 3-38

fields 3-38

profile 3-4

ProfileImage

description 3-39

fields 3-39

Question

description 3-39

fields 3-39

QuestionAnswer

description 3-40

fields 3-40

relationship 3-1

Role

description 3-40

fields 3-40

Suggestions

description 3-41

fields 3-41

Tags

description 3-41

fields 3-41

TagTrends

description 3-41

fields 3-42

TopTag

description 3-42

fields 3-42

User

description 3-42

fields 3-42

VideoProviders

description 3-45

fields 3-45

response

description 1-17

header, description 1-17

payload

description 1-18

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

Suggestions resource     1

User resource     1

Role resource

description 3-40

fields 3-40

S

Search operation

description 1-2, 17-1

executing 17-2

query parameters

count 17-10

filterBy 17-8

overview 17-2

q 17-2

searchMetadata 17-9

sortBy 17-9

startIndex 17-10

startTime 17-10

query tag 17-11

response 17-11

server messages 1-20

sort 1-21

SSO token 1-12

status codes, HTTP 1-19

suggestions

communities to join 9-6

people, communities, and posts 9-2

people to follow 9-4

posts to read 9-8

stop providing 9-10

Suggestions resource

description 3-41

fields 3-41

operations

description 1-2, 9-1

summary 9-1

syntax, command xvi

T

tag

add to post 7-24

create 8-7

delete

from Cisco WebEx Social 8-10

from post 7-25

description 8-1

update name 8-9

tags

applied to post shared with a community, get information about 8-5

get information about 8-3

top trending, get information about 8-11

Tags resource

description 3-41

fields 3-41

operations

description 1-1, 8-1

summary 8-1

TagTrends resource

description 3-41

fields 3-42

operations

description 1-1, 8-1

summary 8-2

Thumbnail activities resource

description 3-61

fields 3-61

TopTag resource

description 3-42

fields 3-42

trusted

application 2-3

device 2-3

U

user

assign Community Owner role 5-22

get information about

all 4-9

designated 4-7

for email address or screen name 4-11

update information about 4-13, 4-64

user group

add to community 5-28

assign Community Owner role 5-30

owner role

add 5-30

remove 5-31

remove from community 5-29

User resource

description 3-42

fields 3-42

operations

description 1-1, 4-1

summary 4-1

profile 3-6

V

verification code 2-5

video

attached 3-24

attach to micropost 7-28

embedded 3-24

update attached 7-30

video provider

add to white list 13-5

get information about 13-3

update information about 13-7

VideoProviders resource

description 3-45

fields 3-45

Video Providers resource operations

description 1-2

summary 13-2

W

watch list, get activities in your 4-70

white list

add video providers to 13-5

delete video provider from 13-8

external video providers 13-2

get video providers 13-3

remove video provider from 13-8

update information video provider 13-7

X

xAuth

description 1-2, 2-3

using with trusted clients 2-18

Y

yourself

community

add to 5-13, 5-16, 5-18

remove from 5-15, 5-20, 5-21

favorite relationship

create 4-74

remove 4-76

follow relationship, create 4-77

information about, get 4-5

like relationship

create 4-95

remove 4-97

profile images, add 4-19

suggestions for

communities to join 9-6

people, communities, and posts 9-2

people to follow 9-4

posts to read 9-8

stop receiving 9-10