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

Resources

Table Of Contents

Resources

General Resources

Resource Profiles

Address Resource

Attachment Resource

Client Resource

ClientAppAsset Resource

ClientAppConfig Resource

CodeOfConduct Resource

Community Resource

CommunityCategory Resource

CommunityType Resource

CommunityUser Resource

CommunityUserGroup Resource

Consumer Resource

CustomAttribute Resource

Device Resource

DocumentFile Resource

DocumentFolder Resource

DocumentLibrary Resource

Email Resource

Entitlement Resource

Favorite Relationship Resource

File Resource

Follow Relationship Resource

Image Resource

Like Relationship Resource

MembershipRequest Resource

Permission Resource

PermissionFlags Resource

Phone Resource

Post Resource

PostComment Resource

ProfileImage Resource

Question Resource

QuestionAnswer Resource

Role Resource

Tags Resource

User Resource

Activities Resources

Activity Activities Resource

Attachment Activities Resource

Blog Activities Resource

Collection Activities Resource

Comment Activities Resource

Community Activities Resource

DocumentFile Activities Resource

DocumentFolder Activities Resource

Event Activities Resource

Media Activities Resource

MediaLink Activities Resource

Message Activities Resource

MessageCategory Activities Resource

Meta Activities Resource

Permission Activities Resource

Person Activities Resource

Post Activities Resource

Thumbnail Activities Resource


Resources


This chapter describes the resources that are used in Cisco WebEx Social API operations. The resources are arranged in two categories: general resources, which represent Cisco WebEx Social entities, activities resources, which represent information about components of a Cisco WebEx Social activity.

This chapter includes these topics:

General Resources

Activities Resources

General Resources

A Cisco WebEx Social API general resource is a representation of a Cisco WebEx Social entity, such as a user, community, post, and so on. Each representation is defined by a resource model, which is a schema that is composed of a set of fields that contain information about the entity.

The schema is used in Cisco WebEx Social operations that create or update items, and in various Cisco WebEx Social operations that retrieve items or information. For example, some Community resource operations return the Community resource, which is a representation of a Cisco WebEx Social community and includes a variety of information about the community.

Representations can be nested, with one or more fields being a resource model of another representation. Such a nested resource is called a child resource. For example, the Community resource model includes the category field, which defines a child resource that represents community categories.

The resource that an API operation targets is specified as part of the operation request.

In some cases, a relationship between two or more different resources are represented by a relationship resource. Relationship resources can represent these Cisco WebEx Social relationships:

Favorite

Follow

Like

Relationship resources are returned only by operations on the source and destination resources of a relationship.

Table 3-1 provides a summary of the API general resources. Each resource is described in detail in the section that is listed.

Each section includes a table that describes the fields that define the entity that the resource represents. The tables provide the following information:

Field—Field name. These names are case-sensitive.

Type—Field type.

Read/Write—Indicates whether a field is read-only (R) or readable and writable (R/W). A field that is identified as R/W can be updated by using the API.

Description—Brief explanation of the field. Valid values, if shown, are case-sensitive.

In addition the "Resource Profiles" section provides information about sets of predefined fields from a resource that can be used with some API requests.

Table 3-1 Summary of Cisco WebEx Social API General Resources 

Resource and Reference
Description

Address Resource

Representation of the physical address of a user

Attachment Resource

Representation of an attachment to a post

Client Resource

Representation of a Cisco WebEx Social API client that is used with OAuth2 authorization and authentication

ClientAppAsset Resource

Representation of an asset that is associated with a custom web application that runs on a specific Cisco WebEx Social mobile client device type

ClientAppConfig Resource

Representation of applications that are available for download to a mobile client device

CodeOfConduct Resource

Representation of the Cisco WebEx Social community code of conduct

Community Resource

Representation of a community

CommunityCategory Resource

Representation of a community category

CommunityType Resource

Representation of the type of community

CommunityUser Resource

Representation of a community member

CommunityUserGroup Resource

Representation a Cisco WebEx Social user group that is assigned to a community

Consumer Resource

Representation of a Cisco WebEx Social API consumer

CustomAttribute Resource

Representation of user properties that can be configured by a Cisco WebEx Social administrator

Device Resource

Representation of information that is specific to a Cisco WebEx Social mobile client device type

DocumentFile Resource

Representation of a representation of a Cisco WebEx social document

DocumentFolder Resource

Representation of a Cisco WebEx Social document folder

DocumentLibrary Resource

Representation of the document library of a user or a community

Email Resource

Representation of the e-mail address of a user

Entitlement Resource

Representation of various Cisco WebEx Social settings that relate to Cisco WebEx Social client features

Favorite Relationship Resource

Representation of a favorite relationship between a user and another Cisco WebEx Social entity

File Resource

Representation of a file that is attached to a post or a micropost or an image that is embedded in a post

Follow Relationship Resource

Representation of a follow relationship between a user and another Cisco WebEx Social entity

Image Resource

Representation of an image file

Like Relationship Resource

Representation of a like relationship between a user and another Cisco WebEx Social entity

MembershipRequest Resource

Representation of a user membership request to a community

Permission Resource

Representation of the permission that is assigned to a post

PermissionFlags Resource

Representation of the status of the permission types that are assigned to a post

Phone Resource

Representation of telephone information of a user

Post Resource

Representation of a post

PostComment Resource

Representation of a comment for a post

ProfileImage Resource

Representation of a Cisco WebEx Social profile image

Question Resource

Representation of questions that a user must answer when creating a community

QuestionAnswer Resource

Representation of the questions and answers that were provided when a community was created

Role Resource

Representation of a Cisco WebEx Social role

Tags Resource

Representation of tags that are associated with a user

User Resource

Representation of a user


Resource Profiles

A resource profile is a set of predefined fields from a general resource that you can use with the fields query parameter in certain API requests. Resource profiles provide a convenient way to specify commonly used sets of fields.

In addition, when a response payload includes a resource that contains a child resource, the child resource displays only the fields that its @basic resource profile defines, if the child resource has such a resource profile.

Cisco WebEx Social includes system-defined resource profiles for several general resources. A Cisco WebEx Social administrator can create other resource profiles.

Table 3-2 lists the resources that include system-defined resource profiles and describes each resource profile.

Table 3-2 System-Defined Resource Profiles 

Resource
Resource Profile Name
Fields in Resource Profile

Community

@basic

description
id
name
shortName
state
type

CommunityCategory

@basic

approvalRequired
description
id
name

CommunityUser

@basic

firstName
fullName
id
images
jobTitle
lastName
roles
screenName
status

CommunityUser

@basic

description
id
name

MembershipRequest

@basic

community
id
requester
status

Post

@basic

createDate
creator
id
summary
tags
title
type

@mobile

commentCount
createDate
creator
editCount
hasAttachments
id
lastModifiedDate
lastTransactionTime
lastTransactionType
rootMessageId
state
summary
tags
title
type
version

User

@basic

firstName
fullName
id
images
jobTitle
lastName
screenName
status


Address Resource

The Address resources is the representation of the physical address of a Cisco WebEx Social user.

Table 3-3 describes the Address resource fields.

Table 3-3 Address Resource Fields 

Field
Type
Read/Write
Description

city

String

R

City in the address of a user

country

String

R

Country in the address of a user

mailing

boolean

R

Indicates whether the address is a mailing address for the user (true = mailing address, false = not mailing address)

primary

boolean

R

Indicates whether the address is the main address of the user (true = main address, false = not main address)

region

String

R

Indicates the region of the address of the user

street1

String

R

First line of the street address of a user

street2

String

R

Second line of the street address of a user

street3

String

R

Third line of the street address of a user

zip

String

R

ZIP code or postal code of a user


Attachment Resource

The Attachment resource is a representation of an attachment to a Cisco WebEx Social post.

Table 3-4 describes the Attachment resource fields.

Table 3-4 Attachment Resource Fields 

Field
Type
Read/Write
Description

author

User

R

User resource, which represents the user who uploaded the attachment to Cisco WebEx Social.

The "User Resource" section describes this resource.

fileName

String

R

File name of the attachment.

id

long

R

Unique system-generated identifier of the attachment.

mimeType

String

R

Type of the attachment.

Valid values are:

DOCUMENT—Document file

IMAGE—Image file

IMAGE_LINK—Link to an image

POST—Cisco WebEx Social post

UNKNOWN_TYPE—Unidentified type

VIDEO—Video file

VIDEO_LINK—Link to a vide file

published

long

R

Date and time that the attachment was uploaded to the system.

resource

String

R

Namespace that identifies this resource type.

size

long

R

Size of the attachment in bytes.

updated

long

R/W

Date and time that the file was updated in the system.


Client Resource

The Client resource is a representation of a Cisco WebEx Social API client that is used with OAuth2 authorization and authentication.

Table 3-5 describes the Client resource fields.

Table 3-5 Client Resource Fields 

Field
Type
R/W
Description

clientId

String

R

Unique system-generated identifier of the API client.

clientSecret

String

R

Client Secret, which the API client uses in the authorization and authentication process.

flow

String

R/W

Type of authorization flow.

Valid values are:

authorization_code—Indicates the OAuth2 authorization code flow

implicit—Indicates the OAuth2 implicit flow

redirectUri

String

R/W

URI of the page to which a user is directed after Cisco WebEx Social authorizes the user.

title

String

R/W

Name of the API client.

type

String

R/W

Type of the API client.

Valid values are:

confidential—Client is able to maintain confidential credentials or secure client communication in another way

public—Client is not able to maintain confidential credentials or secure client communication in another way


ClientAppAsset Resource

The ClientAppAsset resource is a is a representation of an asset that is associated with a custom web application that runs on a specific Cisco WebEx Social mobile client device type.

Table 3-7 describes the ClientAppAsset resource fields.

Table 3-6 ClientAppAsset Resource Fields 

Field
Type
Read/Write
Description

appUrl

String

R

URL from which to access the application with which this asset is associated.

assetType

Enum

R

Information about the asset.

Valid values are:

LARGE_IMAGE—99 x 96 pixels

MEDIUM_IMAGE—48 x 48 pixels

SMALL_SELECTED_IMAGE—30 x 30 pixels

SMALL_UNSELECTED_IMAGE
30 x 30 pixels

assetUrl

String

R

Relative URL from which to access the asset.

deviceId

String

R

Type of mobile client device to which the asset applies.

Valid values are:

mobile.client.iphone—iPhone 3GS, iPod Touch third generation devices

mobile.client.iphone_retina—iPhone 4, iPhone 4S, iPod Touch fourth generation devices

mobile.client.ipad—iPad first and second generation devices

mobile.client.ipad_retina—iPad third generation device

id

long

R

Unique system-generated identifier of the asset.

lastModified

long

R

Date and time that the asset or information about the asset was last updated in Cisco WebEx Social. (See the "Mobile Settings" chapter in Cisco WebEx Social Administration Guide for related information.)

resource

String

R

Namespace that identifies this resource type.


ClientAppConfig Resource

The ClientAppConfig resource is a representation of applications that are available for download to a mobile client device. To be available for download, and application must be added to Cisco Webex Social as described in the "Mobile Settings" chapter in Cisco Webex Social Administration Guide.

Table 3-7 Describes The Clientappconfig Resource Fields.

Table 3-7 ClientAppConfig Resource Fields

Field
Type
Read/Write
Description

appType

Enum

R

Type of application.

The valid value is web.

assets

List
<ClientAppAsset>

R

List of ClientAppAsset resources, which represent assets that are associated with custom web applications that run on specific Cisco WebEx Social client device types.

The "ClientAppAsset Resource" section describes this resource.

description

String

R

Description of the application.

id

String

R

Unique system-generated identifier of the application.

lastModified

long

R

Date and time that the application or information about the application was last updated in Cisco WebEx Social. (See the "Mobile Settings" chapter in Cisco WebEx Social Administration Guide for related information.)

resource

String

R

Namespace that identifies this resource type.

title

String

R

Title of the application.


CodeOfConduct Resource

The CodeOfConduct resource is a representation of the Cisco WebEx Social community code of conduct.

Table 3-8 describes the CodeOfConduct resource fields.

Table 3-8 CodeOfConduct Resource Fields 

Field
Type
Read/Write
Description

enabled

Boolean

R

Indicates whether a user must agree to the Cisco WebEx Social community code of conduct when creating a community (true = user must agree, false = agreement not required)

link

String

R

URL that contains the text of the Cisco WebEx Social community code of conduct


Community Resource

The Community resource is a representation of a Cisco WebEx Social community.

Table 3-9 describes the Community resource fields.

Table 3-9 Community Resource Fields 

Field
Type
Read/Write
Description

category

CommunityCategory

R/W

CommunityCategory resource, which represents the category to which a community belongs.

The "CommunityCategory Resource" section describes this resource.

creator

User

R

User resource, which represents the user who created the community.

The "User Resource" section describes this resource.

description1

String

R/W

Description of the community.

id1

long

R

Unique system-generated identifier of the community.

images

List<ProfileImage>

R/W

List of ProfileImage resources, which represent Cisco WebEx Social profile images of users.

The "ProfileImage Resource" section describes this resource.

liveDate

long

R

Date and time that the community state was set to live.

name1

String

R/W

Name of the community.

questionAnswers

List<QuestionAnswer>

R/W

List of QuestionAnswer resources, which represent questions and answers that were provided when the community was created.

The "QuestionAnswer Resource" section describes this resource.

shortName1

String

R/W

Short URL that can be used to access the community from within Cisco WebEx Social.

For example the shortName value for a community that is named Demo Community could be /demo-community.

state1

String

R/W

State of a request to create a community.

Valid values are:

approved—The request has been approved by an administrator and the community can now be made live

denied—The request has been denied by an administrator and the community cannot be made live

live—Community is live

pending—An administrator has not yet approved nor denied the request

stateChangedDate

long

R

Date and time that the state of the community was last update.

tags

List<Tags>

R/W

List of Tags resources, which represent tags that are associated with a user.

The "Tags Resource" section describes this resource.

type1

CommunityType

R/W

CommunityType resource, which represents the type of community.

The "CommunityType Resource" section describes this resource.

userCount

int

R

Number of users that belong to this community.

userGroupCount

int

R

Number of user groups that belong to this community.

1 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section.


CommunityCategory Resource

The CommunityCategory resource is a representation of a Cisco WebEx Social community category.

Table 3-10 describes the CommunityCategory resource fields.

Table 3-10 CommunityCategory Resource Fields 

Field
Type
Read/Write
Description

approvalRequired1

Boolean

R

Indicates whether a community that is put in this community category requires approval from an administrator before it can be made live (true = requires approval, false = does not require approval).

creator

User

R

User resource, which represents the user who created the community category.

The "User Resource" section describes this resource.

description1

String

R

Description of the community category.

generalCategory

Boolean

R

Indicates whether this community category is the General category (true = General category, false = not General category).

id1

long

R

Unique system-generated identifier of the community category.

images

List<ProfileImage>

R/W

List of ProfileImage resources, which represent Cisco WebEx Social profile images of users.

The "ProfileImage Resource" section describes this resource.

modifiedDate

long

R

Date and time that the community category was last modified.

name1

String

R

Name of the community category.

questions

List<Question>

R

List of Question resources, which represent questions that a user must answer when creating a community that is in this community category.

The "Question Resource" section describes this resource.

1 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section.


CommunityType Resource

The CommunityType resource is a representation of the type of a Cisco WebEx Social community.

Table 3-11 describes the CommunityType resource field.

Table 3-11 CommunityType Resource Field 

Field
Type
Read/Write
Description

enum

R/W

Type of the community.

Valid values are:

hidden

open

restricted


CommunityUser Resource

The CommunityUser resource is a representation of a Cisco WebEx Social community member. This resource is an extension of the User resource. It inherits from the User resource values for each field, except for the roles field, which is not part of the User resource.

Table 3-12 describes the CommunityUser resource fields.

Table 3-12 CommunityUser Resource Fields 

Field
Type
Read/Write
Description

addresses

List<Address>

R

List of Address resources, which represent physical address information of users.

The "Address Resource" section describes this resource.

CustomAttributes

List
<CustomAttributes>

R/W

List of CustomAttribute resources, which represent custom attributes of users.

The "CustomAttribute Resource" sectiondescribes this resource.

emails

List<Email>

R/W

List of Email resources, which represent e-mail information of users.

The "Email Resource" section describes this resource.

endWorkHour

long

R/W

Time that the user starts work.

firstName1

String

R/W

First name of the user.

friendlyJobTitle

String

R/W

Informal job title of the user.

fullName1

String

R

First name and last name of the user.

id1

long

R

Unique system-generated identifier of the user.

images1

List<ProfileImage>

R

List of ProfileImage resources, which represent Cisco WebEx Social profile images of users.

The "ProfileImage Resource" section describes this resource.

jobTitle1

String

R

Formal job title of the user.

legalHold

enum

R/W

Indicates whether a user is on legal hold. Valid values are:

hold—User is on legal hold. This value is visible only to users with the Cisco WebEx Social system administrator privilege.

nohold—User is not on legal hold. This value is visible only to users with the Cisco WebEx Social system administrator privilege.

none—Visible to users who do not have the Cisco WebEx Social system administrator privilege.

lastName1

String

R/W

Last name of the user.

manager

User

R/W

Manager of the user.

The manager is defined by another User resource.

phones

List<Phone>

R/W

List of Phone resources, which represent telephone information of users.

The "Phone Resource" section describes this resource.

resource

String

R

Namespace that identifies this resource type.

roles1

List<Role>

R

List of Role resources, which represent the Cisco Webex Social roles of users.

The "Role Resource" section describes this resource.

screenName1

String

R

Unique Cisco WebEx Social screen name that is defined for the user.

startWorkHour

long

R/W

Time that the user stops work.

status1

enum

R/W

Status of the user in Cisco WebEx Social.

Valid values are

active—Active user

inactive—Deactivated user

tags

List<Tags>

R/W

List of Tags resources, which represent tags that are associated with users.

The "Tags Resource" section describes this resource.

timeZone

String

R/W

Time zone in which the user is located.

1 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section


CommunityUserGroup Resource

The CommunityUserGroup resource is a representation a Cisco WebEx Social user group that is assigned to a community.

Table 3-13 describes the CommunityUserGroup resource fields.

Table 3-13 CommunityUserGroup Resource Field 

Field
Type
Read/Write
Description

creator

User

R

User resource, which represents the user who created the community.

The "User Resource" section describes this resource.

description1

String

R

Description of the user group.

id1

long

R

Unique system-generated identifier or the user group.

name1

String

R

Name of the user group.

roles

List<Role>

R

List of Role resources, which represents the roles that are assigned to each member of the user group.

The "Role Resource" section describes this resource.

1 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section.


Consumer Resource

The Consumer resource is a representation of a Cisco WebEx Social API consumer.

Table 3-14 describes the Consumer resource fields.

Table 3-14 Consumer Resource Fields 

Field
Type
R/W
Description

accessPermission

String

R

Describes the type of access that an API consumer has to Cisco WebEx Social.

Valid values are:

R—Read access

W—Write access

R/W—Read and write access

author

String

R

Name of the developer of the API consumer.

callbackUrl

String

R/W

URL of the page to which a user is directed after Cisco WebEx Social authorizes the user.

consumerKey

String

R

Consumer Key, which the API consumer uses as a credential when authenticating itself through the OAuth process to the Cisco WebEx Social server.

consumerSecret

String

R

Consumer Secret, which the API consumer uses to verify ownership of the consumer key.

createDate

long

R

Date and time that the API consumer was registered with Cisco WebEx Social.

description

String

R/W

Description of the API consumer.

id

Long

R

Unique system-generated identifier of the API consumer.

modifiedDate

long

R

Date and time that information in this resource was last modified.

name

String

R/W

Name of the API consumer.

resource

String

R

Namespace that identifies this resource type.

state

enum

R

The current state of the API consumer.

Valid values are:

active—API consumer has access to Cisco WebEx Social.

inactive—API consumer does not have access to Cisco WebEx Social. The OAuth process prevents an inactive API consumer from accessing Cisco WebEx Social.

type

enum

R

Type of the API consumer.

Valid values are:

desktop—Application that resides on a computer

gadget—Open social gadget application

mobile—Application that resides on a mobile device

web—Application that resides on the world-wide web


CustomAttribute Resource

The CustomAttribute resource is a representation of user properties that can be configured by a Cisco WebEx Social administrator.

Table 3-15 describes the CustomAttribute resource fields.

Table 3-15 CustomAttribute Resource Fields 

Field
Type
Read/Write
Description

dataSelectionValues

List<String>

R

Values of custom attributes, which were defined when the custom attributes were created.

dataType

String

R

Data type of a custom attribute.

Valid values are:

Boolean

Date

Double

Double[ ]

Float

Float[ ]

Integer

Integer[ ]

Long

Long[ ]

Short

Short[ ]

String

String[ ]

id

Not used

key

String

R

Name of the custom attribute.

resource

String

R

Namespace that identifies this resource type.

value

String

R/W

Value of the custom attribute.


Device Resource

The Device resource is a representation of information that is specific to a Cisco WebEx Social mobile client device type.

Table 3-16 describes the Device resource fields.

Table 3-16 Device Resource Fields 

Field
Type
Read/Write
Description

brandingLastUpdated

long

R

Date and time at that the time at which the branding asset file for this mobile client device type was last modified in Cisco WebEx Social. The mobile client uses this value to determine whether a branding asset file is available for it. (See the "Mobile Settings" chapter in Cisco WebEx Social Administration Guide for related information.)

brandingLocation

String

R

Relative URL of the branding asset file for this mobile client device type.

deviceType

String

R

Type of mobile client device to which the branding asset applies.

Valid values are:

mobile.client.iphone—iPhone 3GS, iPod Touch third generation devices

mobile.client.iphone_retina—iPhone 4, iPhone 4S, iPod Touch fourth generation devices

mobile.client.ipad—iPad first and second generation devices

mobile.client.ipad_retina—iPad third generation device

resource

String

R

Namespace that identifies this resource type.


DocumentFile Resource

The DocumentFile resource is a representation of a Cisco WebEx social document file.

Table 3-17 describes the DocumentFile resource fields.

Table 3-17 DocumentFile Resource Fields 

Field
Type
Read/Write
Description

author

User

R

User resource, which represents the user who created the document file.

The "User Resource" section describes this resource.

description

String

R/W

Description of the document file.

folderId

long

R

Identifier of the folder in which the document file is located or to which the document file is to be uploaded.

id

long

R

Unique system-generated identifier of the document file.

mimeType

String

R

Type of the document file.

The valid value is DOCUMENT.

name

String

R

System-generated name of the document file.

published

long

R

Date and time that the document file was uploaded in Cisco WebEx Social.

readCount

long

R

Number of times that the document file has been read by users.

resource

String

R

Namespace that identifies this resource type.

size

long

R

Size in bytes of the document file.

The maximum value is 10485760 (10 MB).

tags

List<Tags>

R/W

List of Tags resources, which represent tags that are associated with the document file.

The "Tags Resource" section describes this resource.

title

String

R/W

Title of the document file.

updated

long

R/W

Date and time that the document file was last modified in Cisco WebEx Social.

updatedBy

User

R

User resource, which represents the user who last updated the document file.

The "User Resource" section describes this resource.

uri

String

R

URI of the location where the document file is stored.

version

double

R

Version of the document file.


DocumentFolder Resource

The DocumentFolder resource is a representation of a Cisco WebEx Social document folder.

Table 3-18 describes the DocumentFolder resource fields.

Table 3-18 DocumentFolder Resource Fields 

Field
Type
Read/Write
Description

community

Community

R

Community resource, which represents the community in which the document folder was created or is to be created.

The "Community Resource" section describes this resource.

createdDate

long

R

Date and time that the document folder was created in Cisco WebEx Social.

creator

User

R

User resource, which represents the user who created the document folder.

The "User Resource" section describes this resource.

description

String

R/W

Description of the document folder.

documents

list<DocumentFile>

R

List of DocumentFile resources , which represent the document files that are in the document folder.

The "DocumentFile Resource" section describes this resource.

id

long

R

Unique system-generated identifier of the document folder.

lastModifiedDate

long

R

Date and time that the document folder was last modified.

name

String

R/W

Name of the document folder.

parentFolderId

long

R

Identifier of the parent folder that contains the document folder.

resource

String

R

Namespace that identifies this resource type.

subFolders

list<DocumentFolder>

R

List of DocumentFile resources, which represent document folders (sub-folders) that are contained in the document folder.


DocumentLibrary Resource

The DocumentLibrary resource is a representation of the document library of a user or a community.

Table 3-19 describes the DocumentLibrary resource fields.

Table 3-19 DocumentLibrary Resource Fields 

Field
Type
Read/Write
Description

documents

List<DocumentFile>

R

List of DocumentFile resources, which represent document files.

The "DocumentFile Resource" section describes this resource.

folders

List<DocumentFolder>

R

List of DocumentFolder resources, which represent document folders.

The "DocumentFolder Resource" section describes this resource.

resource

String

R

Namespace that identifies this resource type.


Email Resource

The Email resource is a representation of the e-mail address of a Cisco WebEx Social user.

Table 3-20 describes the Email resource fields.

Table 3-20 Email Resource Fields 

Field
Type
Read/Write
Description

address

String

User-entered information: R/W

Information from LDAP: R

E-mail address of the user

primary

boolean

R/W

Indicates whether the e-mail address is the primary e-mail address of the user (true = primary address, false = not primary address)


Entitlement Resource

The Entitlement resource is a representation of various Cisco WebEx Social settings that relate to the Cisco WebEx Social client features.

Table 3-4 describes the Entitlement resource fields.

Table 3-21 Entitlement Resource Fields 

Field
Type
Read/Write
Description

mobileBranding

boolean

R

Indicates whether the Cisco WebEx Social branding functionality is enabled for mobile client devices (true = enabled, false = not enabled)

documentService

boolean

R

Indicates whether the following items appear in the Cisco WebEx Social user interface (true = items appear, false = items do not appear):

Documents tab in all libraries

Documents application in the Add Application tray

Documents application in any page

Upload File button in any page

mobileExtensibility

boolean

R

Indicates whether the Cisco WebEx Social extensibility functionality is enabled for mobile client devices (true = enabled, false = not enabled)

likeService

boolean

R

Indicates whether the Like feature is enabled in Cisco WebEx Social for posts and microposts (true = button appears, false = button does not appear)

qnaService

boolean

R

Indicates whether the Question & Answer feature is enabled for a new post, the library, an activity, the watchlist, and a search Cisco WebEx Social (true = feature is available, false = feature is not available)

twitterService

boolean

R

Indicates whether the Twitter integration feature is enabled in Cisco WebEx Social (true = icon appears, false = icon does not appear)

ucChatService

boolean

R

Indicates whether the Web Chat feature is enabled in Cisco WebEx Social (true = items appear, false = items do not appear)

ucWebConfService

boolean

R

Indicates whether the Webex Meeting feature is enabled in Cisco WebEx Social (true = items appear, false = items do not appear)

ucWebPhoneService

boolean

R

Indicates whether the plugin for voice and video calls is available in Cisco WebEx Social (true = plugin is available, false = plugin is not available)

videoService

boolean

R

Indicates whether the Show and Share video integration is enabled in Cisco WebEx Social (true = items appear, false = items do not appear)


Favorite Relationship Resource

The Favorite resource is a relationship resource that represents a favorite relationship between a Cisco WebEx Social user and another Cisco WebEx Social entity.

Table 3-22 describes the Favorite relationship resource fields.

Table 3-22 Favorite Relationship Resource Fields 

Field
Type
Read/Write
Description

destination

Object

R

Resource that represents the target of the favorite relationship.

id

String

R

Unique system-generated identifier of the relationship.

relationship

enum

R

Favorite relationship between the resource that represents the entity for which the relationship is being requested (the source) and the resource that represents entity that is the target of the relationship (the destination).

Valid values are:

favoriting—The destination is a favorite of the source

favoriter—The source is a favorite of the destination

none—There is no favorite relationship between the source and the destination


File Resource

The File resource is a representation of a text or binary file that has been uploaded to Cisco WebEx Social (and which you can later embed in or attach to a post).

Table 3-23 describes the File resource fields.

Table 3-23 File Resource Fields 

Field
Type
R/W
Description

fileName

String

R

Name of the file

id

long

R

Unique system-generated identifier of the file

published

long

R

Date and time that the file was uploaded to the system

resource

String

R

Namespace that identifies this resource type

size

long

R

Size in bytes of the file

updated

long

R

Date and time that the file was updated in the system


Follow Relationship Resource

The Follow resource is a relationship resource that represents a follow relationship between a Cisco WebEx Social user and another Cisco WebEx Social entity.

Table 3-24 describes the Follow relationship resource fields.

Table 3-24 Follow Relationship Resource Fields 

Field
Type
Read/Write
Description

destination

Object

R

Resource that represents the entity that is the target of the following relationship.

id

String

R

Unique system-generated identifier of the relationship.

relationship

enum

R

Follow relationship between the resource that represents the entity for which the relationship is being requested (the source) and the resource that represents entity that is the target of the relationship (the destination).

Valid values are:

following—The source is following the destination

follower—The source is being followed by the destination

both—The source is following and being followed by the destination

none—The source neither is following nor being followed by the destination


Image Resource

The Image resource is a representation of an image file.

Table 3-25 describes the Image resource fields.

Table 3-25 Image Resource Fields 

Field
Type
Read/Write
Description

id

long

R

Unique system-generated identifier of the image

modifiedDate

long

R

Date and time that the image was last modified

name

String

R

Name of the image file

size

long

R

Size in bytes of the image file

type

String

R

Type of the image file (for example, jpeg)

url

String

R

Relative path to the image file on the Cisco WebEx Social server


Like Relationship Resource

The Like resource is a relationship resource that represents a like relationship between a Cisco WebEx Social user and another Cisco WebEx Social entity.

Table 3-26 describes the Like relationship resource fields.

Table 3-26 Like Relationship Resource Fields 

Field
Type
Read/Write
Description

destination

Object

R

Resource that represents the target of the like relationship.

id

String

R

Unique system-generated identifier of the relationship.

relationship

enum

R

Like relationship between the resource that represents the entity for which the relationship is being requested (the source) and the resource that represents entity that is the target of the relationship (the destination).

Valid values are:

liking—The source likes the destination

liker—The destination likes the source

none—The source neither likes nor is liked by the destination


MembershipRequest Resource

The MembershipRequest resource is a representation of a user membership request to a Cisco WebEx Social community.

Table 3-27 describes the MembershipRequest resource fields.

Table 3-27 MembershipRequest Resource Fields 

Field
Type
Read/Write
Description

approver

User

R

User resource, which represents the user who approved or denied membership in the community.

The "User Resource" section describes this resource.

community1

Community

R

Community resource, which represents the community in which membership has been requested.

The "Community Resource" section describes this resource.

createDate

long

R

Date and time that the membership request was submitted.

id1

long

R

Unique system-generated identifier of the membership request.

replyComments

String

R/W

Comments that the user who approved a request for membership in the community posted when replying to the request.

replyDate

long

R

Date and time that the membership request was approved or denied.

requestComments

String

R/W

Comments that the user who requested membership in the community posted with the request.

requester1

User

R

User resource, which represents the user who requested membership in the community.

The "User Resource" section describes this resource.

status1

String

R/W

Current status of the membership request.

Valid values are:

approved—Request has been approved by an administrator

denied—Request has been denied by an administrator

pending—No action has been taken on this request by an administrator

1 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section.


Permission Resource

The Permission resource is a representation of the permission that is granted to user or community for access to a Cisco WebEx Social post.

Table 3-28 describes the Permission resource fields.

Table 3-28 Permission Resource Fields 

Field
Type
Read/Write
Description

principal

User
or
Community

R/W

User is a User resource, which represents a Cisco WebEx Social user. The "User Resource" section describes this resource.

Community is a Community resource, which represents a Cisco WebEx Social community. The "Community Resource" section describes this resource.

permissionFlags

List<PermissionFlags>

R/W

List of PermissionFlags resources, which represent the status of permission types.

The "PermissionFlags Resource" section describes this resource.


PermissionFlags Resource

The PermissionFlags resource is a representation of the status of the permission types that are assigned to a user or a community for access to a Cisco WebEx Social post.

Table 3-29 describes the PermissionFlags resource fields.

Table 3-29 PermissionFlags Resource Fields 

Field
Type
Read/Write
Description

authorize

boolean

R/W

Indicates whether the entity has authorize permission for the post (true = has authorize permission, false = does not have authorize permission)

comment

boolean

R/W

Indicates whether the entity has comment permission for the post (true = has comment permission, false = does not have comment permission)

edit

boolean

R/W

Indicates whether the entity has edit permission for the post (true = has edit permission, false = does not have edit permission)

share

boolean

R/W

Indicates whether the entity has share permission for the post (true = has share permission, false = does not have share permission)

view

boolean

R/W

Indicates whether the entity has view permission for the post (true = has view permission, false = does not have view permission)


Phone Resource

The Phone resource is a representation of telephone information of a user.

Table 3-30 describes the Phone resource fields.

Table 3-30 Phone Resource Fields 

Field
Type
Read/Write
Description

extension

String

R/W

Telephone extension of a user

number

String

R/W

Area code and telephone number of the user

primary

boolean

R/W

Indicates whether the telephone number is the primary number for the user (true = primary address, false = not primary address)

type

String

R/W

Description of the device that is associated with the telephone number.

Valid values are:

business

businessfax

mobile

pager

personal

personalfax

other

tty


Post Resource

The Post resource is a representation of a Cisco WebEx Social post.

Table 3-31 describes the Post resource Fields.

Table 3-31 Post Resource Fields 

Field
Type
Read/Write
Description

attachments

List<Attachment>

R/W

List of Attachment resources, which represent attachments to a post.

The "Attachment Resource" section describes this resource.

attachmentsCount

int

R

Number of files that are attached to the post.

body

String

R/W

Body of the post.

commentCount1

int

R

Number of comments that have been made on the post.

createDate1, 2

long

R

Date and time that the post was created.

creator1, 2

User

R

User resource, which represents the user who created the post.

The "User Resource" section describes this resource.

defaultPermissions

PermissionFlags

R/W

PermissionFlags resource, which represents the status of the permission types that are assigned to a user or a community for access to a Cisco WebEx Social post.

The "PermissionFlags Resource" section describes this resource.

editCount1

int

R

Number of edits that have been made to the post. This values increments each time any user edits the post.

embeddedMedia

List<Attachment>

R/W

List of attachment resources, which represent media files that are embedded in the post content.

The "Attachment Resource" section describes this resource.

externalPost

boolean

R

Indicates whether the post has been posted outside of Cisco WebEx Social (true = posted outside of Cisco WebEx Social, false = not posted outside of Cisco WebEx Social).

hasAttachments1

boolean

R

Indicates whether the post includes attachments (true = has attachments, false = does not have attachments).

id1, 2

long

R

Unique system-generated identifier of the post.

lastModifiedDate1

long

R

Date and time that the post was last modified.

lastModifier

User

R

User resource, which represents the user who last modified the post.

The "User Resource" section describes this resource.

lastTransactionTime1

long

R

Date and time that the last transaction that affected the post occurred.

lastTransactionType1

String

R

Type of transaction that was last performed on the post.

Valid values are:

COMMENT—A user added a comment to the post

COMMENT_DELETE—A user deleted a comment from the post

COMMENT_UPDATE—A user updated a comment on the post

CREATE—A user created the post

FAVORITE—A user added the post to favorites

PERMISSION_REVOKE—A user was denied permission to access the post

SHARE—A user shared the post

UPDATE—A user updated the post

lastTransactionUser

User

R

User resource, which represents the user who last performed a transaction on the post.

The "User Resource" section describes this resource.

likesCount

int

R

Number of users who like this post.

permissions

List<Permission>

R/W

List of Permission resources, which represent permissions that a Cisco WebEx Social user or community has been granted for the post.

The "Permission Resource" section describes this resource.

publicPost

boolean

R/W

Indicates whether this post is a public post (true = public post, false = not a public post).

resource

String

R

Namespace that identifies this resource type.

rootMessageId1

long

R

System-generated ID of the root of a comment tree.

state1

enum

R/W

State of the post.

Valid values are:

ACTIVE—Post is accessible to users

DELETED—Post is deleted

FLAGGED—Post is flagged for review by an administrator

HIDDEN—Post is hidden

INACTIVE—Post is inactive

summary1, 2

String

R

Summary of the post, based on the initial characters of the post body (not including HTML tags).

tags1, 2

List<Tags>

R/W

List of Tags resources, which represent tags that have been applied to the post.

The "Tags Resource" section describes this resource.

title1, 2

String

R/W

Title of the post.

type1, 2

enum

R/W

Type of the post

Valid values are:

COMMUNITY_WALL—Post that appears on the wall of a community

MICRO—Micropost

TEXT—Standard Cisco WebEx Social post

VIDEO—Video post

WALL—Post that appears on the wall of a user

version1

long

R

Version of the post.

1 This field is included in the @mobile resource profile for this resource. For related information, see the "Resource Profiles" section.

2 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section.


PostComment Resource

The PostComment resource is a representation of a comment for a Cisco WebEx Social post.

Table 3-32 describes the PostComment resource fields.

Table 3-32 PostComment Resource Fields 

Field
Type
Read/Write
Description

body

String

R/W

Body of the comment.

createDate

long

R

Date and time that the comment was created.

creator

User

R

User resource, which represents the user who created the comment.

The "User Resource" section describes this resource.

id

long

R

Unique system-generated identifier of the comment.

modifiedDate

long

R

Date and time that the comment was last edited.

parentMessageId

long

R/W

Identifier of the comment to which this comment is the reply.

For a first-level comment on a post, this identifier is the identifier of the root of the comment tree.

replyCount

int

R

Number of replies that have been made to this comment.


ProfileImage Resource

The ProfileImage resource is a representation of a Cisco WebEx Social profile image.

Table 3-33 describes the ProfileImage resource fields.

Table 3-33 ProfileImage Resource Fields 

Field
Type
Read/Write
Description

image

Image resource

R

Resource that represents an image.

The "Image Resource" section describes this resource.

sizeType

string

R

Size of the image.

Valid values are:

SMALL—24 x 24 pixels

MEDIUM1—31 x 31 pixels

MEDIUM2—48 x 48 pixels

MEDIUM3—64 x 64 pixels

MEDIUM4—110 x 110 pixels

LARGE—150 x 150 pixels


Question Resource

The Question resource is a representation of questions that a user must answer when creating a community.

Table 3-34 describes the Question resource fields.

Table 3-34 Question Resource Fields 

Field
Type
Read/Write
Description

answerOptions

List<String>

R

List of answers to be used if the value of the answerType field is selection for this question.

answerType

String

R

Type of answer that is required in response to the question (see below).

Valid values are:

freeform—Answer can be any text string

selection—Answer must be selected from the list that the answerOptions field defines

id

long

R

Unique system-generated identifier of this question.

question

String

R

Text of a question that must be answered when creating a community that belongs to a category that has this question assigned to it.


QuestionAnswer Resource

The QuestionAnswer resource is a representation of the questions and answers that were provided when a community was created.

Table 3-35 describes the QuestionAnswer resource fields.

Table 3-35 QuestionAnswer Resource Fields 

Field
Type
Read/Write
Description

questionId

long

R/W

Unique identifier of the question that is being answered. (The question is represented in the CommunityCategory resource. Table 3-10 describes this resource.)

question

String

R

Text of the question that was answered.

answer

String

R/W

Text of the answer.


Role Resource

The Role resource is a representation of a Cisco WebEx Social role.

Table 3-36 describes the Role resource fields.

Table 3-36 Role Resource Fields 

Field
Type
Read/Write
Description

description

String

R

Description of the role

id

long

R

Unique system-generated identifier of the role

name

String

R

Name of role

title

String

R

Title of the role


Tags Resource

The Tags resource is a representation of tags that are associated with a user.

Table 3-37 describes the Tags resource fields.

Table 3-37 Tags Resource Fields 

Field
Type
Read/Write
Description

id

long

R

Unique system-generated identifier of the tag

name

String

R/W

Descriptive name of the tag

resource

String

R

Namespace that identifies this resource type

type

String

R/W

Type of tag.

Valid values are:

expertise

interest

tags


User Resource

The User resource is a representation of a Cisco WebEx Social user.

Table 3-38 describes the User resource fields.

Table 3-38 User Resource Fields 

Field
Type
Read/Write
Description

addresses

List<Address>

R

List of Address resources, which represent physical address information of users.

The "Address Resource" section describes this resource.

CustomAttributes

List
<CustomAttributes>

R/W

List of CustomAttribute resources, which represent custom attributes of a user.

The "CustomAttribute Resource" sectiondescribes this resource.

emailFeaturedPosts

Email

R

Email resource, which represents the e-mail address of the Featured Posts page of Cisco Webex Social.

The "Email Resource" section describes this resource.

emailMyLibrary

Email

R

Email resource, which represents the e-mail address of the My Library of Cisco Webex Social.

The "Email Resource" section describes this resource.

emails

List<Email>

R/W

List of Email resources, which represent e-mail information of users.

The "Email Resource" section describes this resource.

endWorkHour

long

R/W

Time that the user starts work.

eula

enum

R/W

Indicates whether the user has accepted the Cisco WebEx Social end user license agreement (EULA).

Valid values are:

accepted—User has accepted the EULA. This value is visible only to users with the Cisco WebEx Social system administrator privilege and to the user whose information is retrieved.

rejected—User has not accepted the EULA. This value is visible only to users with the Cisco WebEx Social system administrator privilege and to the user whose information is retrieved.

none—Appears for users who do not have the Cisco WebEx Social system administrator privilege and retrieve the information of another user.

firstName1

String

R/W

First name of the user.

friendlyJobTitle

String

R/W

Informal job title of the user.

fullName1

String

R

First name and last name of the user.

id1

long

R

Unique system-generated identifier of the user.

images1

List<ProfileImage>

R

List of ProfileImage resources, which represent Cisco WebEx Social profile images of users.

The "ProfileImage Resource" section describes this resource.

jobTitle1

String

R

Formal job title of the user.

lastName1

String

R/W

Last name of the user.

legalHold

enum

R/W

Indicates whether a user is on legal hold.

Valid values are:

hold—User is on legal hold. This value is visible only to users with the Cisco WebEx Social system administrator privilege.

nohold—User is not on legal hold. This value is visible only to users with the Cisco WebEx Social system administrator privilege.

none—Appears for users who do not have the Cisco WebEx Social system administrator privilege.

manager

User

R/W

Manager of the user.

The manager is defined by another User resource.

phones

List<Phone>

R/W

List of Phone resources, which represent telephone information of users.

The "Phone Resource" section describes this resource.

resource

String

R

Namespace that identifies this resource type.

screenName1

String

R

Unique Cisco WebEx Social screen name that is defined for the user.

startWorkHour

long

R/W

Time that the user stops work.

status1

enum

R/W

Status of the user in Cisco WebEx Social.

Valid values are:

active—Active user

inactive—Deactivated user

tags

List<Tags>

R/W

List of Tags resources, which represent tags that are associated with users.

The "Tags Resource" section describes this resource.

timeZone

String

R/W

Time zone in which the user is located.

1 This field is included in the @basic resource profile for this resource. For related information, see the "Resource Profiles" section


Activities Resources

A Cisco WebEx Social API activities resource represents information about a component of a Cisco WebEx Social activity. Each representation is defined by a resource model, which is a schema that is composed of a set of fields that contain information about the entity.

An activity consists of the components actor, action, object, and target. An activity describes an action that is performed by an actor with or on an object that relates to a target. For example, an actor could be a Cisco WebEx Social user, an action could be "created," an object could be a document, and a target could be a library.

A component may be explicit or implied. For example, an activity could be described as "Nicole updated a document in her library" or "Mike shared a post."

Activities resources include fields that conform to the open format activitystrea.ms specifications for serializing streams of activities in JSON and in Atom formats. In addition, some activities resources include fields that are specific to Cisco WebEx social. These fields are called Cisco extensions.

Representations can be nested, with one or more fields being an activity resource model of another representation. Such a nested resource is called a child resource. For example, the Post activities resource model includes the attachments field, which defines a child resource that represents attachments to the post.

Activities resources are included in the return results of the following API operations:

Get Information about All Activities that are Visible to You

Get Information about All Activities that Appear in Your Watch List

Get Information about all Activities that Appear in the Profile Page of a User

Get All Activities that are Visible to You in a Community

Table 3-39 provides a summary of the API activities resources and describes the components that the activities resources can represent in an activity. Each activities resource is described in detail in the section that is listed.

Field—Field name. These names are case-sensitive.

Type—Field type.

Cisco extension—Indicates whether the field is specific to Cisco WebEx social. A Cisco extension field is outsider of the scope of the Activity Streams specification.

Description—Brief explanation of the field. Valid values, if shown, are case-sensitive.

Table 3-39 Summary of Cisco WebEx Social API Activities Resources 

Activities Resource and Reference
Description

Activity Activities Resource

Representation of a Cisco WebEx Social activity

Attachment Activities Resource

Representation of an attachment to a post

Blog Activities Resource

Representation of a Cisco WebEx Social blog

Collection Activities Resource

Representation of a collection of items

Comment Activities Resource

Representation of a comment on or a reply to a post

Community Activities Resource

Representation of a community

DocumentFile Activities Resource

Representation of a document file

DocumentFolder Activities Resource

Representation of a document folder

Event Activities Resource

Representation of a calendar entry

Media Activities Resource

Representation of an image or video

MediaLink Activities Resource

Representation of a profile image

Message Activities Resource

Representation of a comment or reply in a discussion forum

MessageCategory Activities Resource

Representation of a message category in a discussion forum

Meta Activities Resource

Representation of a relationship between the logged-in user and the Post activities resource

Permission Activities Resource

Representation representation of the status of the permission types that are assigned to user for access to a Cisco WebEx Social post

Person Activities Resource

Representation of a user

Post Activities Resource

Representation of a post

Thumbnail Activities Resource

Representation of a thumbnail image of a media file


Activity Activities Resource

The Activity activities resource is an activitystrea.ms compliant representation of a Cisco WebEx Social activity.

Table 3-40 describes the Activity Activities resource fields.

Table 3-40 Activity Activities Resource Fields 

Field
Type
Cisco Extension
Description

actor

Object

No

Activities resource that represents the entity that performed the activity.

The "Person Activities Resource" section describes the activities resource that represents an actor.

id

String

No

Unique system-generated identifier of the activity.

object

Object

No

Activities resource that represents the object of the activity.

The following sections describe the activities resources that represent the entities that can be object of an activity:

Attachment Activities Resource

Blog Activities Resource

Comment Activities Resource

Community Activities Resource

DocumentFile Activities Resource

DocumentFolder Activities Resource

Event Activities Resource

MessageCategory Activities Resource

Message Activities Resource

Person Activities Resource

Post Activities Resource

published

Date-time

No

Date at time that the activity occurred.

target

Object

No

Activities resource that represents the target of the activity.

The following sections describe the activities resources that represent the entities that can be target of an activity:

Community Activities Resource

DocumentFolder Activities Resource

to

Collection
<Object>

No

Collection activities resource, which represents users and communities with which this activity is shared.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items can include the activities resources that the following sections describe:

Community Activities Resource

Person Activities Resource

verb

String

No

Identifies the action that the activity performed.

Valid values are:

add—Add a comment to a post, reply to a comment in a post, add an event to a calendar, upload an image, or add a message to a discussion forum

change—Change the question in a Question post

delete—Delete a post, or delete a comment from a post

follow—Create a follow relationship

mutualFollow—Create a follow relationship with a user who is following the user for whom this relationship is created

post—Create a post

share—Share a post

unfollow—Stop a follow relationship

update—Update a post, update a comment to a post, or update a reply to a post

upload—Upload a document


Attachment Activities Resource

The Attachment activities resource is an activitystrea.ms compliant representation of an attachment to a post.

Table 3-41 describes the Attachment activities resource fields.

Table 3-41 Attachment Activities Resource Fields 

Field
Type
Cisco Extension
Description

displayName

String

No

Base file name of the attachment.

ext

String

Yes

File name extension of the attachment (for example, txt).

id

String

No

Unique system-generated identifier of the attachment.

objectType

String

No

Type of this entity.

The valid value is attachment.

url

String

No

Relative URL of the location of the attachment file.


Blog Activities Resource

The Blog activities resource is an activitystrea.ms compliant representation of a Cisco WebEx Social blog.

Table 3-42 describes the Blog activities resource fields.

Table 3-42 Blog Activities Resource Fields 

Field
Type
Cisco Extension
Description

objectType

String

No

Type of this entity.

The valid value is blog.

title

String

No

Title of the blog.

url

String

No

Relative URL of the HTML representation of the blog.


Collection Activities Resource

The Collection activities resource is an activitystrea.ms compliant representation of a collection of items.

Table 3-43 describes the Collection activities resource fields.

Table 3-43 Collection Activities Resource Fields 

Field
Type
Cisco Extension
Description

items

Array
<Object>

No

Array of activities resources.

objectType

String

No

Type of this entity.

The valid value is collection.

totalItems

int

No

Total number Cisco WebEx Social entities that match the query. This value may not match the actual number of items that are returned.


Comment Activities Resource

The Comment activities resource is an activitystrea.ms compliant representation of a comment on or a reply to a post. A comment also is represented by the PostComment resource, as described in the "PostComment Resource" section.

Table 3-44 describes the Comment activities resource fields.

Table 3-44 Comment Activities Resource Fields 

Field
Type
Cisco Extension
Description

id

String

No

Unique system-generated identifier of the comment.

inReplyTo

Collection
<Object>

No

Collection activities resource, which represents the comment that this comment or reply is in response to.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resource that the "Comment Activities Resource" section describes.

objectType

String

No

Type of this entity.

Valid values are:

comment

reply

resource

String

Yes

Namespace that identifies this activities resource type.

summary

String

No

Summary of the comment, based on the initial characters of the comment body.

url

String

No

Relative URL of the PostComment resource that represents this comment.


Community Activities Resource

The Community activities resource is an activitystrea.ms compliant representation of a Cisco WebEx Social community. A community also is represented by the Community resource, as described in the "Community Resource" section.

Table 3-45 describes the Community activities resource fields.

Table 3-45 Community Activities Resource Fields 

Field
Type
Cisco Extension
Description

displayName

String

No

Name of the community.

id

String

No

Unique system-generated identifier of the community.

objectType

String

No

Type of this entity.

The valid value is community.

url

String

No

Relative URL of the Community resource that represents this comment.


DocumentFile Activities Resource

The DocumentFile activities resource is an activitystrea.ms compliant representation of a document file. A document file also is represented by the DocumentFile resource, as described in the "DocumentFile Resource" section.

Table 3-46 describes the DocumentFile activities resource fields.

Table 3-46 DocumentFile Activities Resource Fields 

Field
Type
Cisco Extension
Description

displayName

String

No

Title of the document file.

id

String

No

Unique system-generated identifier of the document file.

objectType

String

No

Type of this entity.

The valid value is file.

resource

String

Yes

Namespace that identifies this activities resource type.

url

String

No

Relative URL of the DocumentFile resource that represents this document file.


DocumentFolder Activities Resource

The DocumentFolder activities resource is an activitystrea.ms compliant representation of a document folder. A document file also is represented by the DocumentFolder resource, as described in the "DocumentFolder Resource" section.

Table 3-47 describes the DocumentFolder activities resource fields.

Table 3-47 DocumentFolder Activities Resource Fields 

Field
Type
Cisco Extension
Description

displayName

String

No

Title of the document folder.

id

String

No

Unique system-generated identifier of the document folder.

objectType

String

No

Type of this entity.

The valid value is folder.

resource

String

Yes

Namespace that identifies this activities resource type.

url

String

No

Relative URL of the DocumentFolder resource that represents this document folder.


Event Activities Resource

The Event activities resource is an activitystrea.ms compliant representation of a calendar entry.

Table 3-48 describes the Event activities resource fields.

Table 3-48 Event Activities Resource Fields 

Field
Type
Cisco Extension
Description

objectType

String

No

Type of this entity.

The valid value is event.

title

String

No

Title of the calendar entry.

url

String

No

Relative URL of the HTML representation of the event.


Media Activities Resource

The Media activities resource is an activitystrea.ms compliant representation of an image or video.

Table 3-49 describes the Media activities resource fields.

Table 3-49 Media Activities Resource Fields 

Field
Type
Cisco Extension
Description

height

String

Yes

Height of the image, in pixels.

width

String

Yes

Width of the image, in pixels.

mediaId

String

Yes

Unique system-generated identifier of the image.

mediaType

String

Yes

Type of this object.

Valid values are:

image

video

mediaSz

String

Yes

Size of the media file, in bytes.

url

String

No

Relative URL of the location of this media file.


MediaLink Activities Resource

The MediaLink activities resource is an activitystrea.ms compliant representation of a Cisco WebEx Social profile image.

Table 3-50 describes the MediaLink activities resource fields.

Table 3-50 MediaLink Activities Resource Fields 

Field
Type
Cisco Extension
Description

height

Int

No

Height of the image, in pixels

url

String

No

Relative URL of the location of this image file

width

Int

No

Width of the image, in pixels


Message Activities Resource

The Message activities resource is an activitystrea.ms compliant representation of a comment or reply in a discussion forum.

Table 3-51 describes the Message activities resource fields.

Table 3-51 Message Activities Resource Fields 

Field
Type
Cisco Extension
Description

id

String

No

Unique system-generated identifier of the message.

inReplyTo

Collection
<Message>

No

Collection activities resource, which represents the message that this comment or reply is in response to.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resources that the "Message Activities Resource" section describes.

objectType

String

No

Type of this entity.

Valid values are:

comment

reply

resource

String

Yes

Namespace that identifies this activities resource type.

summary

String

No

Summary of the message, based on the initial characters of the message body.

url

String

No

Relative URL of the HTML representation of the message.


MessageCategory Activities Resource

The MessageCategory activities resource is an activitystrea.ms compliant representation of a message category in a discussion forum.

Table 3-52 describes the MessageCategory activities resource fields.

Table 3-52 MessageCategory Activities Resource Fields 

Field
Type
Cisco Extension
Description

displayName

String

No

Name of the message category.

id

String

No

Unique system-generated identifier of the message category.

objectType

String

No

Type of this entity.

The valid value is message_category.

url

String

No

Relative URL of the HTML representation of the message category.


Meta Activities Resource

The Meta activities resource is an activitystrea.ms compliant representation of a relationship between the logged-in user and the Post activities resource.

Table 3-53 describes the Meta activities resource fields.

Table 3-53 Meta Activities Resource Fields 

Field
Type
Cisco Extension
Description

favorite

String

Yes

Favorite relationship between the logged-in user and the post.

Valid values are:

favoriting—The user has established a favorite relationship with the post

favoriter—The post has been favorited by the user

none—There is no favorite relationship between the source and the destination

flagable

Boolean

Yes

Indicates whether the user has flag the post (true = can flag, false = cannot flag).

like

String

Yes

Like relationship between the logged-in user and the post.

Valid values are:

liking—The user likes the post

liker—The post is liked by a user

none—There is no like relationship between the user and the post

permission

Permission

Yes

Activities resource that describes the permission that is granted to the logged-in user for access to the Cisco WebEx Social post.

The "Permission Activities Resource" section describes this activities resource.


Permission Activities Resource

The Permission activities resource is an activitystrea.ms compliant representation of the status of the permission types that are assigned to user for access to a Cisco WebEx Social post.

Table 3-54 describes the Permission activities resource fields.

Table 3-54 Permission Activities Resource Fields 

Field
Type
Cisco Extension
Description

comment

Boolean

Yes

Indicates whether the user has comment permission for the post (true = has comment permission, false = does not have comment permission)

edit

Boolean

Yes

Indicates whether the user has edit permission for the post (true = has edit permission, false = does not have edit permission)

share

Boolean

Yes

Indicates whether the user has share permission for the post (true = has share permission, false = does not have share permission)


Person Activities Resource

The Person activities resource is an activitystrea.ms compliant representation of a Cisco WebEx user. A user also is represented by the User resource, as described in the "User Resource" section.

Table 3-55 describes the Person activities resource fields.

Table 3-55 Person Activities Resource Fields 

Field
Type
Cisco Extension
Description

displayName

String

No

Full name of the user.

id

String

No

Unique system-generated identifier of the user.

image

MediaLink

No

Activities resource that describes the profile image of the user.

The "MediaLink Activities Resource" section describes this activities resource.

objectType

String

No

Type of this entity.

The valid value is person.

resource

String

Yes

Namespace that identifies this activities resource type.

screenName

String

Yes

Unique Cisco WebEx Social screen name that is defined for the user.

status

String

Yes

Status of the user in Cisco WebEx Social.

Valid values are:

active—Active user

inactive—Deactivated user

url

String

No

Relative URL of the User resource that represents this user.


Post Activities Resource

The Post activities resource is an activitystrea.ms compliant representation of a Cisco WebEx post. A post also is represented by the User resource, as described in the "Post Resource" section.

Table 3-56 describes the Post activities resource fields.

Table 3-56 Post Activities Resource Fields 

Field
Type
Cisco Extension
Description

activities

Collection
<Activity>

Yes

Collection activities resource, which represents replies to and comments on the post.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resource that the "Activity Activities Resource" section describes.

attachments

Collection
<Attachment>

No

Collection activities resource, which represents attachments to the post.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resource that the "Attachment Activities Resource" section describes.

author

Object

No

Collection activities resource, which represents the user who authored the post.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resources that the "Person Activities Resource" section describes.

displayName

String

No

Title of the post.

id

String

No

Unique system-generated identifier of the post.

inReplyTo

Collection
<Object>

No

Collection activities resource, which represents the item that this comment or reply is in response to.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resources that the "Comment Activities Resource" section describes.

likes

Collection
<Object>

Yes

Collection activities resource, which represents the entities that liked this post.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resources that the "Person Activities Resource" section describes.

objectType

String

No

Type of this entity.

The valid values is post.

postQuestion

Boolean

Yes

Designates whether a post is a question (true = question, false = not a question).

postVersion

String

Yes

Version of the post.

resource

String

Yes

Namespace that identifies this activities resource type.

summary

String

No

Summary of the message, based on the initial characters of the post body.

to

Collection
<Object>

No

Collection activities resource, which represents users and communities with which this post is shared.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items can include the activities resources that the following sections describe:

Community Activities Resource

Person Activities Resource

thumbnails

Collection
<Thumbnail>

Yes

Collection activities resource, which represents thumbnail images of a media file that is attached to the post.

The "Collection Activities Resource" section describes this resource. In the Collection activities resource, the array of items includes the activities resources that the "Thumbnail Activities Resource" section describes.

type

String

Yes

Type of the post.

Valid values are:

community_wall—Post that appears on the wall of a community

micro—Micropost

text—Standard Cisco WebEx Social post

video—Video post

wall—Post that appears on the wall of a user

wiki—Wiki representation of a post

url

String

No

Relative URL of the Post resource that represents this post.


Thumbnail Activities Resource

The Thumbnail activities resource is an activitystrea.ms compliant representation of a thumbnail image of a media file.

Table 3-57 describes the Thumbnail activities resource fields.

Table 3-57 Thumbnail Activities Resource Fields 

Field
Type
Cisco Extension
Description

media

Media

Yes

Activities resource that describes the source image or video for this thumbnail image.

The "Media Activities Resource" section describes this activities resource.

objectType

String

No

Type of this entity.

The valid value is image.

url

String

No

Relative URL of the location of this thumbnail image file.