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

Configuration Operations

Table Of Contents

Configuration Operations

Video Providers Resource Operations

Video Providers Resource Operations Summary

Get Information about Video Providers in the White List

Add a Video Provider to the Video Providers White List

Update Information about a Video Provider in the Video Providers White List

Delete the Designated Video Provider from the Video Providers White List

Portal Settings Resource Operation

Portal Settings Resource Operation Summary

Get Information about Portal Settings

Entitlement Resource Operation

Entitlement Resource Operation Summary

Get Information about Settings that have been Configured for Cisco WebEx Social Clients

Eula Resource Operation

Eula Resource Operation Summary

Get Information about the Cisco WebEx Social EULA


Configuration Operations


The Cisco WebEx Social API includes operations for retrieving information about and managing various configuration items. These operations include:

Video Providers resource operations—Provide functionality for managing a white list of external video providers from which videos can be embedded in TEXT type posts or attached to microposts, wall posts, or community walls posts

Portal Settings resource operation—Lets you retrieve information about selected settings that have been configured in the Account Settings > Portal drawer > Settings page in Cisco WebEx Social

Entitlement resource operation—Lets you retrieve information about settings that have been configured for Cisco WebEx Social clients

Eula resource operation— Lets you retrieve information about the Cisco WebEx Social end user license agreement (EULA)

This chapter includes these topics, which describe the configuration operations in detail:

Video Providers Resource Operations

Portal Settings Resource Operation

Entitlement Resource Operation

Eula Resource Operation

Video Providers Resource Operations

The Video Providers resource operations provide functionality for managing a white list of external video providers from which videos can be embedded in TEXT type posts or attached to microposts, wall posts, or community walls posts.

Only videos that come from the external providers that are included in the white list can be used in Cisco WebEx Social.

Video Providers Resource Operations Summary

Table 14-1 provides a summary of the Video Providers operations. Each operation is described in detail in the section that is listed.

These sections provide this information:

Purpose—Brief explanation of the operation

Availability—Cisco WebEx Social releases that support the operation

Request—HTTP method and URI for the operation

Request Payload—Description of the request payload, if the operation requires one

Response—Description of the expected response when the operation executes

Example—Sample request and response for the operation

Table 14-1 Video Providers Operations Summary 

Operation and Reference
Purpose

Get Information about Video Providers in the White List

Retrieves information about external video providers that are included in the video providers white list

Add a Video Provider to the Video Providers White List

Adds an external video provider to the video providers white list

Update Information about a Video Provider in the Video Providers White List

Updates information about an external video provider in the video providers white list

Delete the Designated Video Provider from the Video Providers White List

Deletes the designated video provider from the video providers white list


Get Information about Video Providers in the White List

Purpose

Retrieves information about external video providers that are included in the video providers white list.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/config/videoproviders[/provider_id]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

provider_id—Identifier of the video provider for which to retrieve information. To obtain a list of video provider identifiers, execute this operation without including provider_id.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one VideoProvider resource (the "VideoProviders Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/config/videoproviders
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
  "statusCode" : 200,
  "startIndex" : 0,
  "itemsPerPage" : 1,
  "totalResults" : 1,
  "filtered" : false,
  "sorted" : false,
  "entry" : [ {
    "data" : {
      "description" : "a description of the service provider",
      "fqdn" : "www.youtube.com",
      "id" : "51434336e4b093efa3225ea1",
      "resource" : "http://quad.cisco.com/schema/1.0/config/videoproviders",
      "template" : "<iframe width=\"$WIDTH\" height=\"$HEIGHT\" src=\"$VIDEO_URL\" 
frameborder=\"0\" allowfullscreen></iframe>"
    }
  } ],
  "serverMessages" : null
}

Add a Video Provider to the Video Providers White List

Purpose

Adds an external video provider to the video providers white list.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

POST

{http|https}://server[:port]/api/quad/rest/config/videoproviders


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

Request Payload

The request payload includes fields from the VideoProviders resource (the "VideoProviders Resource" section describes these fields):

Required Fields
Optional Fields

fqdn
template

description


Response

Standard response (see the "API Responses" section) with a response payload that can include one VideoProviders resource (the "VideoProviders Resource" section describes this resource).

Example

Request

POST http://webexsocialserver/api/quad/rest/config/videoproviders
Accept: application/json
Content-Type: application/json
{
   "description": "Some test video provider description",
   "fqdn": "www.vimeo.com",
   "template": "<iframe width=\"$WIDTH\" height=\"$HEIGHT\" src=\"$VIDEO_URL\" 
         frameborder=\"0\" allowfullscreen></iframe>"
}

Response

HTTP/1.1 201 Created
Location: http://webexsocialserver/api/quad/rest/documentfolders/1010009
Content-Type: application/json
    {
        "statusCode": 200,
        "startIndex": 0,
        "itemsPerPage": 1,
        "totalResults": 1,
        "filtered": false,
        "sorted": false,
        "entry":
        [
            {
                "data":
               {
                     "description": "Some test video provider description",
                     "fqdn": "www.vimeo.com",
                     "id": "50a1f52de4b0edba348da307",
                     "resource": "http://quad.cisco.com/schema/1.0/config/videoproviders",
                     "template": "ssss43433ssssdfdfdfdssdsqqqqsdsds"
               }
            }
        ],
        "serverMessages": null
}

Update Information about a Video Provider in the Video Providers White List

Purpose

Updates information about an external video provider in the video providers white list.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

PUT

{http|https}://server[:port]/api/quad/rest/config/videoproviders/provider_id


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

provider_id—Identifier of the video provider for which to update information. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

Request Payload

The request payload includes fields from the VideoProviders resource ("VideoProviders Resource" section describes these fields):

Required Fields
Optional Fields

fqdn
template

description


Response

Standard response (see the "API Responses" section) with an HTTP header only.

Example

Request

PUT http://webexsocialserver/api/quad/rest/config/videoproviders/509d240e40cebe14eab
Accept:application/json
Content-Type: application/json
{
   "description": "Some test video provider description edited",
   "fqdn": "www.vimeo.com",
   "template": "<iframe width=\"$WIDTH\" height=\"$HEIGHT\" src=\"$VIDEO_URL\" 
      frameborder=\"0\" allowfullscreen></iframe>"
}

Response

HTTP/1.1 204 No Content

Delete the Designated Video Provider from the Video Providers White List

Purpose

Deletes the designated video provider from the video providers white list.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

DELETE

{http|https}://server[:port]/api/quad/rest/videoproviders/provider_id


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

provider_id—Identifier of the video provider for which to retrieve information. For information about obtaining the identifier that you need, see the "Identifiers of Cisco WebEx Social Entities" section.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with an HTTP header only.

Example

Request

DELETE http://webexsocialserver/api/quad/rest/config/videoproviders/509d240e40cebe14eab

Response

HTTP/1.1 204 No Content

Portal Settings Resource Operation

The Cisco WebEx Social API Portal Settings resource operation lets you retrieve information about selected settings that have been configured in the Account Settings > Portal drawer > Settings page in Cisco WebEx Social.

Portal Settings Resource Operation Summary

Table 14-2 provides a summary of the Portal Settings resource operation. This operation is described in detail in the section that is listed. The section provide this information:

Purpose—Brief explanation of the operation

Availability—Cisco WebEx Social releases that support the operation

Request—HTTP method and URI for the operation

Request Payload—Description of the request payload, if the operation requires one

Response—Description of the expected response when the operation executes

Example—Sample request and response for the operation

Table 14-2 Portal Settings Resource Operation Summary 

Operation and Reference
Purpose

Get Information about Portal Settings

Retrieves information about selected settings that have been configured in the Account Settings > Portal drawer > Settings page in Cisco WebEx Social


Get Information about Portal Settings

Purpose

Retrieves information about selected settings that have been configured in the Account Settings > Portal drawer > Settings page in Cisco WebEx Social.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/config/portalsettings


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one PortalSettings resource (the "PortalSettings Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/config/portalsettings
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
{
   "statusCode" : 200,
   "startIndex" : 0,
   "itemsPerPage" : 1,
   "totalResults" : 1,
   "filtered" : false,
   "sorted" : false,
   "entry" : [ {
     "data" : {
       "portalUrl" : "http://localhost",
       "resource" : "http://quad.cisco.com/schema/1.0/portalsettings"
     }
   } ],
   "serverMessages" : null
 }

Entitlement Resource Operation

The Cisco WebEx Social API Entitlement resource operation lets you retrieve information about settings that have been configured for Cisco WebEx Social clients.

Entitlement Resource Operation Summary

Table 14-3 provides a summary of the Entitlement resource operation. This operation is described in detail in the section that is listed. The section provide this information:

Purpose—Brief explanation of the operation

Availability—Cisco WebEx Social releases that support the operation

Request—HTTP method and URI for the operation

Request Payload—Description of the request payload, if the operation requires one

Response—Description of the expected response when the operation executes

Example—Sample request and response for the operation

Table 14-3 Entitlement Resource Operation Summary 

Operation and Reference
Purpose

Get Information about Settings that have been Configured for Cisco WebEx Social Clients

Retrieves information about settings that have been configured for Cisco WebEx Social clients


Get Information about Settings that have been Configured for Cisco WebEx Social Clients

Purpose

Retrieves information about settings that have been configured for Cisco WebEx Social clients.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/config/entitlement
[?query_parameters]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

query_parameters—Query parameters. See the "Query Parameters" section for information about using query parameters. For this operation:

The fields query parameter is supported for selecting fields from the Settings resource to include in a response (Table 3-24 describes these fields)

The filterBy query parameter is not supported for filtering resources in a response

The sortOrder query parameter does not apply

The startIndex query parameter does not apply

The count query parameter does not apply

The meta query parameter does not apply

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one Entitlement resource (the "Entitlement Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/config/entitlement
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 
   
  {
   "statusCode": 200,
   "startIndex": 0,
   "itemsPerPage": 1,
   "totalResults": 1,
   "filtered": false,
   "sorted": false,
   "entry": [
     {
       "data": {
         "documentService": true,
         "excelPlugin": false,
         "likeService": true,
         "mobileBranding": false,
         "mobileExtensibility": false,
         "notesPlugin": true,
         "outlookPlugin": true,
         "powerPointPlugin": false,
         "qnaService": true,
         "resource": "http://quad.cisco.com/schema/1.0/entitlement",
         "termsOfUseRequired": true,
         "twitterService": true,
         "ucChatService": true,
         "ucWebConfService": true,
         "ucWebPhoneService": true,
         "videoService": false,
         "wordPlugin": false
       }
     }
   ],
   "serverMessages": null
 } 

Eula Resource Operation

The Cisco WebEx Social API Eula resource operation lets you retrieve information about the Cisco WebEx Social EULA.

Eula Resource Operation Summary

Table 14-4 provides a summary of the Eula Resource operation. This operation is described in detail in the section that is listed. The section provide this information:

Purpose—Brief explanation of the operation

Availability—Cisco WebEx Social releases that support the operation

Request—HTTP method and URI for the operation

Request Payload—Description of the request payload, if the operation requires one

Response—Description of the expected response when the operation executes

Example—Sample request and response for the operation

Table 14-4 Eula Resource Operation Summary 

Operation and Reference
Purpose

Get Information about the Cisco WebEx Social EULA

Retrieves information about the Cisco WebEx Social EULA


Get Information about the Cisco WebEx Social EULA

Purpose

Retrieves information about the Cisco WebEx Social EULA.

Availability

Cisco WebEx Social 3.4 and later.

Request

HTTP Method
URI

GET

{http|https}://server[:port]/api/quad/rest/config/eula[&language=language]


where:

server—Host name or IP address of the Cisco WebEx Social server.

port—Port number on which the Cisco WebEx Social server listens for API requests. The default value is 80.

language—Language of the EULA about which to retrieve information. Valid values are:

ar-SA—Arabic (Saudi Arabia)

de-DE—German (Germany)

en-US—English (United States)

es-ES—Spanish (Spain)

es-LA—Spanish (Latin America)

fr-FR—French (France)

it-IT—Italian (Italy)

ja-JP—Japanese (Japan)

ko-KR—Korean (Korea)

nl-NL—Dutch (Netherlands)

pt-BR—Portuguese (Brazil)

ru-RU—Russian (Russia)

zh-CN—Chinese (China)

zh-TW—Chinese (Taiwan)

If you do not specify a value for language, the system uses the default EULA language that is configured in Cisco WebEx Social.

Request Payload

A request payload is not required.

Response

Standard response (see the "API Responses" section) with a response payload that can include one Eula resource (the "Eula Resource" section describes this resource).

Example

Request

GET http://webexsocialserver/api/quad/rest/config/eula
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 {
   "statusCode": 200,
   "startIndex": 0,
   "itemsPerPage": 1,
   "totalResults": 1,
   "filtered": false,
   "sorted": false,
   "entry": [
     {
       "data": {
         "content": "<p><strong>Important: Please read this end user license agreement 
carefully. It is very important that you check that you are purchasing Cisco software or 
equipment from an approved source and that you, or the entity you represent (collectively, 
the customer) have been registered as the end user for the purposes of this Cisco end user 
license agreement. If you are not registered as the end user you have no license to use 
the software and the limited warranty in this end user license agreement does not apply. 
Assuming you have purchased from an approved source, downloading, installing or using 
Cisco or Cisco-supplied software constitutes acceptance of this agreement. 
</strong></p><p>Cisco Systems, Inc. or its subsidiary licensing the software instead of 
Cisco Systems, Inc. (Cisco) is willing to license this software to you only upon the 
condition that you purchased the software from an approved source and that you accept all 
of the terms contained in this end user license agreement plus any additional limitations 
on the license set forth in a supplemental license agreement accompanying the product or 
available at the time of your order (collectively the agreement). To the extent of any 
conflict between the terms of this end user license agreement and any supplemental license 
agreement, the supplemental license agreement shall apply. By downloading, installing, or 
using the software, you are representing that you purchased the software from an approved 
source and binding yourself to the agreement.</p>",
         "language": "en_US",
         "resource": "http://quad.cisco.com/schema/1.0/eula"
       }
     }
   ]
 }