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

Index

Table Of Contents

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

Index

Symbols

@mention, in micropost 8-8, 8-11

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

using in request

OAuth 1.0a 2-18

OAuth 2.0 2-19

activities

definition 4-68, 4-72, 4-74, 6-59, 8-47

information about, get

in a community, visible to you 6-59

in profile page 4-74

in your watch list 4-72

related to post 8-47

visible to you 4-68

activities resource

See also resource

Activity

description 3-52

fields 3-52

Attachment

description 3-54

fields 3-54

Blog

description 3-55

fields 3-55

Collection

description 3-55

fields 3-55

Comment

description 3-55

fields 3-56

Community

description 3-56

fields 3-56

description 3-50

DocumentFile

description 3-57

fields 3-57

DocumentFolder

description 3-57

fields 3-57

Event

description 3-57

fields 3-58

Media

description 3-58

fields 3-58

MediaLink

description 3-58

fields 3-59

MessageCategory

description 3-59

fields 3-60

Meta

description 3-60

fields 3-60, 3-61

Permission

description 3-61

fields 3-62

Person

description 3-62

fields 3-62

Post

description 3-63

fields 3-63

Reason

description 3-65

fields 3-66

Thumbnail

description 3-66

fields 3-66

Activity activities resource

description 3-52

fields 3-52

activitystrea.ms 3-51

Address resource

description 3-7

fields 3-7

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

User Group resource 1-1

User resource 1-1

Video Providers resource 1-2

operations

See operations

overview 1-1

request format 1-12

response, description 1-18

API client

add 17-2

definition 2-1

description 17-1

registering 2-11, 2-16

API Client resource operations

description 1-2, 17-1

summary 17-1

API consumer

add 16-6

definition 2-1

description 16-1

get information about

multiple 16-4

one 16-2

registering 2-3

update 16-8

API Consumer resource operations

description 1-2, 16-1

summary 16-1

application programming interface

See API

attached video

delete from micropost 8-32

description 3-25

in post, information about 8-27

Attachment activities resource

description 3-54

fields 3-54

Attachment resource

description 3-8

fields 3-8

attachments

add to post 8-14

delete from post 8-16

information about 8-12

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

B

Blog activities resource

description 3-55

fields 3-55

C

child resource 3-1

ClientAppAsset resource

description 3-9

fields 3-9

ClientAppConfig resource

description 3-10

fields 3-10

Client resource

description 3-8

fields 3-8

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

code of conduct, get 6-63

CodeOfConduct resource

description 3-11

fields 3-11

Collection activities resource

description 3-55

fields 3-55

command

conventions xvi

syntax xvi

comment

create 8-21

delete from post 8-24

inappropriate, reporting 4-100

in post, information about

all 8-19

one 8-17

update 8-23

Comment activities resource

description 3-55

fields 3-56

communities

information about 6-6

to which user belongs 4-25

to which you belong 4-23

visible on

user profile 4-29

your profile 4-27

community

add

owner to 6-22, 6-30

user group to 6-28

user to 6-16, 6-18

yourself to 6-13

create 6-8

delete 6-12

description 6-1

information about 6-4

membership requests, information about 6-40

owner, add 6-22, 6-30

posts, information about 6-42

profile images

information about 6-56

update 6-58

questions and answers, information about 6-44

remove

owner from 6-23, 6-31

user from 6-20, 6-21

user group from 6-29

yourself from 6-15

update 6-10

update information about 6-54

user, add 6-16, 6-18

user group, add 6-28

user groups, information about 6-32

users, information about 6-24, 6-26

Community activities resource

description 3-56

fields 3-56

community category

information about

multiple 6-36

one 6-34

types supported 6-38

CommunityCategory resource

description 3-14

fields 3-14

profile 3-5

CommunityMetrics resource

description 3-15

fields 3-15

Community Owner role

add to user 6-22

add to user group 6-30

remove from user 6-23, 6-31

Community resource

description 3-11

fields 3-12

operations

description 1-1, 6-1

summary 6-1

profile 3-4

CommunityType resource

description 3-16

fields 3-16

CommunityUserGroup resource

description 3-18

fields 3-18

profile 3-5

CommunityUser resource

description 3-16

fields 3-16

profile 3-5

configuration operations

description 1-2, 14-1

Entitlement resource 14-1, 14-11

Eula resource 14-1, 14-14

Portal resource 14-1, 14-9

Video Provide resource 14-1, 14-2

Consumer resource

description 3-18

fields 3-19

conventions, command xvi

count 1-23

custom applications, information about, get 15-4

CustomAttribute resource

description 3-20

fields 3-20

custom attributes

retrieve

for community 6-52

for user 4-61, 4-63

update

for community 6-54

for user 4-66

D

data format

Atom 1-12

description 1-12

JSON 1-12

multipart/form-data 1-12

XML 1-12

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

designated version 11-12

document folder 12-7

favorite relationship, removing 4-78

file 13-6

follow relationship, users you are following 4-93

like relationship, for yourself 4-99

micropost, attached video 8-32

post

attachments 8-16

comment 8-24

suggestions, stop providing 10-10

tag

from Cisco WebEx Social 9-10

from post 8-26

user group 5-9

video providers 14-8

Device resource

description 3-21

fields 3-21

DiscussionForumCategory resource

description 3-21

fields 3-22

DocumentFile

activities resource

description 3-57

fields 3-57

resource

description 3-23

fields 3-23

document file

delete

all versions 11-13

designated version 11-12

description 11-1

get information about

all versions 11-6

current version 11-2

designated version 11-4

update information about 11-10

upload 11-8

Document File resource operations

description 1-2, 11-1

summary 11-1

document files, get information about

in community 6-50

user

authored by in user document library 4-59

authored by in your document library 4-55

in document library 4-57

yours

community document library, in 6-48

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

document folder

create 12-4

description 12-1

get information about 12-2

remove 12-7

update information about 12-6

DocumentFolder activities resource

description 3-57

fields 3-57

DocumentFolder resource

description 3-24

fields 3-24

Document Folder resource operations

description 1-2, 12-1

summary 12-1

document library, information about, get

for community 6-46

for user 4-49

in your document library 4-47

DocumentLibrary resource

description 3-24

fields 3-25

E

Email resource

description 3-25

fields 3-25

embedded video

definition 3-25

in micropost, information about 8-27

EmbeddedVideo resource

description 3-25

fields 3-26

end user license agreement (EULA) 3-28, 14-14

Entitlement resource

description 3-26

fields 3-27

operation

description 1-2, 14-11

summary 14-11

Eula resource

description 3-28

fields 3-28

operation

description 1-2, 14-14

summary 14-14

Event activities resource

description 3-57

fields 3-58

F

favorite

post, of user 8-37

posts

user 4-45

yours 4-43

relationship

create 4-76

remove 4-78

Favorite resource

description 3-29

fields 3-29

favorites, user, favorite posts of 4-45

field selection 1-22

file

delete from server 13-6

get from server 13-2

upload to server 13-4

File resource

description 3-29

fields 3-29

operations

description 1-2, 13-1

summary 13-1

filter 1-22

follow relationship

count

users following user 4-86

users following you 4-83

users that a user is following 4-92

users that you and a user are following 4-96

users that you are following 4-89

create 4-79

get 4-81

remove yourself from 4-93

users

a user is following 4-90

who are following a user 4-84

you and a user are following 4-94

you are following 4-87

Follow resource

description 3-30

fields 3-30

G

GET operations

API consumer, information about 16-2

API consumers, information about 16-4

communities

information about 6-6

visible to you 6-6

community

code of conduct 6-63

information about 6-4

membership requests, information about 6-40

metrics 6-61

posts, information about 6-42

profile images, information about 6-56

questions and answers, information about 6-44

community category

information about

multiple     1

one     1

types supported 6-38

custom applications, information about 15-4

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

document folder, information about 12-2

file, information about 13-2

follow relationship

users a user is following 4-90

users following you 4-81

users you and a user are following 4-94

users you are following 4-87

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 14-12, 14-15

communities

to which user belongs     1

to which you belong     1

visible on

user profile     1

your profile     1

custom applications 15-4

custom attributes 4-63

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

portal settings 14-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 email address or screen name     1

user group 5-2

user groups 5-5

to which user belongs     1

users in     1

users 4-9

yourself 4-5

membership request, information about 7-2

micropost, attached video, information about 8-27

mobile client, device type, information about 15-2

post

attachment 8-12

comment, information about

multiple     1

one     1

embedded video, information about 8-27

information about

multiple     1

one     1

permissions, information about 8-33

users

who like post     1

who marked post as favorite     1

post versions

differences between 8-44

information about 8-42

Search 18-2

suggestions

communities to join 10-6

people, communities, and posts 10-2

people to follow 10-4

posts to read 10-8

tags, information about 9-3

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

user group, assigned to community 6-32

video provider, information about 14-3

H

header

Accept 1-12

Accept-Encoding:gzip 1-12

Content-Type 1-12

HTTP 1-18

response, description 1-18

SSO token in 1-12

HEAD operations

follow relationship, users

a user is following 4-92

following user 4-86

following you 4-83

you and a user are following 4-96

you are following 4-89

post, users who like 8-41

HTTP

header 1-18

methods 1-12

status codes 1-20

I

identifiers, of Cisco WebEx Social entities 1-13

Image resource

description 3-30

fields 3-30

implicit flow, steps 2-16

inappropriate

comment, reporting 4-100

content, reporting 4-100

post, reporting 4-100

index, return results 1-22

information 8-12

L

like

count of users who like post 8-41

post, by user 8-39

relationship

create for yourself 4-97

remove for yourself 4-99

Like resource

description 3-31

fields 3-31

M

Media activities resource

description 3-58

fields 3-58

MediaLink activities resource

description 3-58

fields 3-59

membership request

information about

all 6-40

one 7-2

update 7-4

MembershipRequest resource

description 3-31

fields 3-31

profile 3-5

Membership Request resource operations

description 1-1, 7-1

summary 7-1

MessageCategory activities resource

description 3-59

fields 3-60

Meta activities resource

description 3-60

fields 3-60, 3-61

metadata 1-23

Metadata resource

description 3-32

fields 3-33

metrics, get 6-61

micropost

attached video, delete 8-32

embedded video, information about 8-27

get

user 4-41

yours 4-39

video, attach 8-29

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

Mobile Client operations

description 1-2, 15-1

summary 15-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-12

authorization code flow, overview 2-11

description 2-2

flow

authorization code 2-11

implicit 2-16

overview 2-11

OpenSearchDescription 18-12

operations

API Client resource

description 1-2, 17-1

summary 17-1

API Consumer resource

description 1-2, 16-1

summary 16-1

Community resource

description 1-1, 6-1

summary 6-1

configuration

description 1-2, 14-1

Entitlement resource 14-1, 14-11

Eula resource 14-1, 14-14

Portal resource 14-1, 14-9

Video Providers resource 14-1, 14-2

Document File resource

description 1-2, 11-1

summary 11-1

Document Folder resource

description 1-2, 12-1

summary 12-1

Entitlement resource

description 1-2

summary 14-11

Eula resource

description 1-2, 14-14

summary 14-14

File resource

description 1-2, 13-1

summary 13-1, 15-1

Membership Request resource

description 1-1, 7-1

summary 7-1

Mobile Client

description 1-2, 15-1

summary 15-1

Portal Settings resource

description 1-2, 14-9

summary 14-9

Post resource

description 1-1, 8-1

summary 8-1

Search

description 1-2, 18-1

executing 18-2

query parameters

count     1

filterBy     1

overview     1

q     1

searchMetadata     1

sortBy     1

startIndex     1

startTime     1

response 18-11

Suggestions resource

description 1-2, 10-1

summary 10-1

summary of 1-2

Tags resource

description 1-1, 9-1

summary 9-1

TagTrends resource

description 1-2, 9-1

summary 9-2

User Group resource

description 1-1, 5-1

summary 5-1

User resource

description 1-1, 4-1

summary 4-1

Video Providers resource

description 1-2

summary 14-2

P

pagination 1-22

payload

request, description 1-17

response

description 1-19

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

UserGroup resource     1

User resource     1

Permission activities resource

description 3-61

fields 3-62

PermissionFlags resource

description 3-35

fields 3-35

Permission resource

description 3-34

fields 3-35

permissions

for post 8-33

update for post 8-35

Person activities resource

description 3-62

fields 3-62

Phone resource

description 3-36

fields 3-36

portal settings, information about 14-10

PortalSettings resource

description 3-36

fields 3-36

Portal Settings resource operation

description 1-2, 14-9

summary 14-9

post

attached video

information about 8-27

update 8-31

attachments

add 8-14

delete 8-16

information about 8-12

comment

create 8-21

delete 8-24

information about 8-17

update 8-23

comments, information about 8-19

create 8-7

delete 8-10

description 8-1

favorite, of user 8-37

inappropriate, reporting 4-100

information about 8-3

like

by user 8-39

count of users who like 8-41

permissions

information about 8-33

update 8-35

update 8-10

Post activities resource

description 3-63

fields 3-63

PostComment resource

description 3-41

fields 3-41

POST operations

API client, add 17-2

API consumer, add 16-6

community

add

owner     1, 2

user     1, 2

user group     1

yourself     1

create 6-8

profile images 6-58

document file, upload 11-8

document folder, create 12-4

favorite relationship, create for you and user 4-76

file, upload 13-4

follow relationship

create, for yourself and user 4-79

users following user 4-84

inappropriate content, reporting 4-100

like relationship, for yourself 4-97

micropost, video, attach 8-29

post

attachment, add 8-14

comment, create 8-21

new 8-7

profile images, adding

for user 4-21

for yourself 4-19

tag

add to post 8-25

new 9-7

user group, create 5-7

video provider, add to white list 14-5

Post resource

description 3-36

fields 3-37

operations

description 1-1, 8-1

summary 8-1

profile 3-6

posts

favorites

user 4-45

yours 4-43

get information about 6-42

information about 8-5

in your library

all, get 4-33

recent, get 4-35

visible on

user profile, get 4-37

your profile, get 4-31

post version

information about 8-42

restore 8-46

PostVersionDiff resource

description 3-42

fields 3-42

PostVersion resource

description 3-42

fields 3-42

post versions

differences between 8-44

ProfileImage resource

description 3-43

fields 3-43

profile images

community

information about 6-56

update 6-58

sizes 3-43, 4-19, 4-21

update

user 4-17

yours 4-15

upload

for user 4-21

for yourself 4-19

PUT operations

API consumer, update 16-8

attached video, update 8-31

community

custom attributes 6-54

update 6-10

document file, update information about 11-10

document folder, update information about 12-6

membership request 7-4

post

comment, update 8-23

information about, update 8-10

permissions, update 8-35

post version

restore 8-46

tag, update name 9-9

user

custom attributes 4-66

information 4-13

user group

information about, update 5-8

video provider, update information about 14-7

Q

query parameter

count 1-23

description 1-21

field selection 1-22

filter 1-22

index 1-22

metadata 1-23

pagination 1-22

Search operation, in 18-2

separating multiple 1-21

sort 1-22

using 1-21

query tag 18-11

QuestionAnswer resource

description 3-44

fields 3-44

Question resource

description 3-43

fields 3-43

questions and answers, information about 6-44

R

Reason activities resource

description 3-65

fields 3-66

refreshing Access Token

OAuth 1.0a 2-8

OAuth 2.0 2-15

relationship

resource 3-1

request

format, API operations 1-12

formats supported 1-12

payload, description 1-17

Request Token, obtaining 2-3

resource

See also activities resource

activities

See activities resource

Address

description 3-7

fields 3-7

Attachment

description 3-8

fields 3-8

child 3-1

Client

description 3-8

fields 3-8

ClientAppAsset

description 3-9

fields 3-9

ClientAppConfig

description 3-10

fields 3-10

CodeOfConduct

description 3-11

fields 3-11

Community

description 3-11

fields 3-12

CommunityCategory

description 3-14

fields 3-14

CommunityMetrics

description 3-15

fields 3-15

CommunityType

description 3-16

fields 3-16

CommunityUser

description 3-16

fields 3-16

CommunityUserGroup

description 3-18

fields 3-18

Consumer

description 3-18

fields 3-19

CustomAttribute

description 3-20

fields 3-20

description 1-11, 3-1

Device

description 3-21

fields 3-21

DiscussionForumCategory

description 3-21

fields 3-22

DocumentFile

description 3-23

fields 3-23

DocumentFolder

description 3-24

fields 3-24

DocumentLibrary

description 3-24

fields 3-25

Email

description 3-25

fields 3-25

EmbeddedVideo

description 3-25

fields 3-26

Entitlement

description 3-26

fields 3-27

Eula

description 3-28

fields 3-28

Favorite

description 3-29

fields 3-29

File

description 3-29

fields 3-29

Follow

description 3-30

fields 3-30

general 3-1

Image

description 3-30

fields 3-30

Like

description 3-31

fields 3-31

MembershipRequest

description 3-31

fields 3-31

Metadata

description 3-32

fields 3-33

model 3-1

Permission

description 3-34

fields 3-35

PermissionFlags

description 3-35

fields 3-35

Phone

description 3-36

fields 3-36

PortalSettings

description 3-36

fields 3-36

Post

description 3-36

fields 3-37

PostComment

description 3-41

fields 3-41

PostVersion

description 3-42

fields 3-42

PostVersionDiff

description 3-42

fields 3-42

profile 3-4

ProfileImage

description 3-43

fields 3-43

Question

description 3-43

fields 3-43

QuestionAnswer

description 3-44

fields 3-44

relationship 3-1

Role

description 3-44

fields 3-44

Suggestions

description 3-44

fields 3-44

Tags

description 3-45

fields 3-45

TagTrends

description 3-45

fields 3-45

TopTag

description 3-46

fields 3-46

User

description 3-46

fields 3-46

UserGroup

description 3-49

fields 3-49

VideoProviders

description 3-49

fields 3-50

response

description 1-18

header, description 1-18

payload

description 1-19

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

UserGroup resource     1

User resource     1

Role resource

description 3-44

fields 3-44

S

Search operation

description 1-2, 18-1

executing 18-2

query parameters

count 18-10

filterBy 18-8

overview 18-2

q 18-2

searchMetadata 18-9

sortBy 18-9

startIndex 18-10

startTime 18-10

query tag 18-11

response 18-11

server messages 1-20

sort 1-22

SSO token 1-12

status codes, HTTP 1-20

suggestions

communities to join 10-6

people, communities, and posts 10-2

people to follow 10-4

posts to read 10-8

stop providing 10-10

Suggestions resource

description 3-44

fields 3-44

operations

description 1-2, 10-1

summary 10-1

syntax, command xvi

T

tag

add to post 8-25

create 9-7

delete

from Cisco WebEx Social 9-10

from post 8-26

description 9-1

update name 9-9

tags

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

get information about 9-3

top trending, get information about 9-11

Tags resource

description 3-45

fields 3-45

operations

description 1-1, 9-1

summary 9-1

TagTrends resource

description 3-45

fields 3-45

operations

description 1-2, 9-1

summary 9-2

Thumbnail activities resource

description 3-66

fields 3-66

TopTag resource

description 3-46

fields 3-46

trusted

application 2-3

device 2-3

U

user

assign Community Owner role 6-22

get information about

all 4-9

designated 4-7

for email address or screen name 4-11

profile image, add 4-21

update information about 4-13, 4-66

user group

add to community 6-28

assign Community Owner role 6-30

create 5-7

delete 5-9

get information about 5-2

owner role

add 6-30

remove 6-31

remove from community 6-29

update 5-8

User Group resource

operations

description 1-1, 5-1

UserGroup resource

description 3-49

fields 3-49

user groups

get information about 5-5

to which user belongs 5-3

users in 5-10

User resource

description 3-46

fields 3-46

operations

description 1-1, 4-1

summary 4-1, 5-1

profile 3-7

V

verification code 2-5

video

attached 3-25

attach to micropost 8-29

embedded 3-25

update attached 8-31

video provider

add to white list 14-5

get information about 14-3

update information about 14-7

VideoProviders resource

description 3-49

fields 3-50

Video Providers resource operations

description 1-2

summary 14-2

W

watch list, get activities in your 4-72

white list

add video providers to 14-5

delete video provider from 14-8

external video providers 14-2

get video providers 14-3

remove video provider from 14-8

update information about video provider 14-7

X

xAuth

description 1-2, 2-3

using with trusted clients 2-19

Y

yourself

community

add to 6-13, 6-16, 6-18

remove from 6-15, 6-20, 6-21

favorite relationship

create 4-76

remove 4-78

follow relationship, create 4-79

information about, get 4-5

like relationship

create 4-97

remove 4-99

profile image, add 4-19

suggestions for

communities to join 10-6

people, communities, and posts 10-2

people to follow 10-4

posts to read 10-8

stop receiving 10-10