Cisco WebEx Social API Reference Guide, Release 3.0
Document Folder Resource Operations
Downloads: This chapterpdf (PDF - 132.0KB) The complete bookPDF (PDF - 14.42MB) | Feedback

Document Folder Resource Operations

Table Of Contents

Document Folder Resource Operations

Get Information about a Document Folder

Create a Document Folder

Update Information about a Document Folder

Delete the Designated Document Folder


Document Folder Resource Operations


A Cisco WebEx Social document folder is a folder in the document library of a user or community that can contain document files and other document folders.

The Cisco WebEx Social API Document Folder resource operations let you obtain information about document folders perform various actions with document folders.

Table 9-1 provides a summary of the Document Folder resource 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

Examples—Sample requests and responses for the operation

Table 9-1 Document Folder Resource Operations Summary 

Operation and Reference
Purpose

Get Information about a Document Folder

Retrieves information about the subfolders and document files that are in a designated document folder

Create a Document Folder

Creates a document folder in the designated user library or designated community library

Update Information about a Document Folder

Updates Information about the designated document folder

Delete the Designated Document Folder

Deletes the designated document folder


Get Information about a Document Folder

Purpose

Retrieves information a about the subfolders and document files that are in a designated document folder

Availability

Cisco WebEx Social 3.0 and later.

Request

HTTP Method
URI

GET

http://server[:port_number]/api/quad/rest/documentfolders/folder_id
[?query_parameters]


where:

server

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

port_number

Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.

folder_id

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

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 DocumentFolder resource to include in a response (Table 3-14 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 DocumentFolder resource (the "DocumentFolder Resource" section describes this resource). XML and JSON formats are supported.

XML Example

Request

GET http://webexsocialserver/api/quad/rest/documentfolders/468185
Accept:application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
 
   

The response can also include the DocumentFolder resource. For an example, see the "DocumentFolder Resource Response: XML Format, One Resource Returned" section.

JSON Example

Request

GET http://webexsocialserver/api/quad/rest/documentfolders/468185
Accept:application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json
 
   

The response can also include the DocumentFolder resource. For an example, see the "DocumentFolder Resource Response: JSON Format, One Resource Returned" section.

Create a Document Folder

Purpose

Creates a document folder that are in the designated user library or designated community library.

Availability

Cisco WebEx Social 3.0 and later.

Request

HTTP Method
URI

POST

http://server[:port_number]/api/quad/rest/documentfolders
[?query_parameters]


where:

server

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

port_number

Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 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 DocumentFolder resource to include in a response (Table 3-14 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

The request payload includes fields from the DocumentFolder resource (Table 3-14 describes these fields):

Required Fields
Optional Fields

name

community1
description
parentFolderId2

1 If you specify a community, the document folder is created in the community library of that community. Otherwise, the document folder is created in the library of the user who executes this operation.

2 If you specify a parent folder identifier, the document folder is created as a subfolder of that folder. Otherwise, the document folder is created at the root level.


Response

Standard response (see the "API Responses" section) with a response payload that can include one Document Folder resource (the "DocumentFolder Resource" section describes this resource). XML and JSON formats are supported.

XML Example

Request

POST http://webexsocialserver/api/quad/rest/documentfolders
Accept: application/xml
Content-Type: application/xml
 
   
<documentfolder>
  <name>Test Folder by User </name>
  <description>Test Folder in User Library</description>
</documentfolder>

Response

HTTP/1.1 201 Created
Location: http://webexsocialserver/api/quad/rest/documentfolders/1010011
Content-Type: application/xml
 
   

The response can also include the DocumentFolder resource. For an example, see the "DocumentFolder Resource Response: XML Format, One Resource Returned" section.

JSON Example

Request

POST http://webexsocialserver/api/quad/rest/documentfolders
Accept: application/json
Content-Type: application/json
 
   
{ 
  "description" : "Test Folder in User Library",
  "name" : "Test Folder by User"
}

Response

HTTP/1.1 201 Created
Location: http://webexsocialserver/api/quad/rest/documentfolders/1010009
Content-Type: application/json
 
   

The response can also include the DocumentFolder resource. For an example, see the "DocumentFolder Resource Response: JSON Format, One Resource Returned" section.

Update Information about a Document Folder

Purpose

Updates information about the designated document folder.

Availability

Cisco WebEx Social 3.0 and later.

Request

HTTP Method
URI

PUT

http://server[:port_number]/api/quad/rest/documentfolders/folder_id


where:

server

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

port_number

Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.

folder_id

Identifier of the folder 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 DocumentFolder resource (Table 3-14 describes these fields):

Required Fields
Optional Fields

name

description
parentFolderId


Response

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

XML Example

Request

PUT http://webexsocialserver/api/quad/rest/documentfolders/1010011
Accept:application/xml
Content-Type: application/xml
 
   
<documentfolder>
  <name>Test Folder by User Updated </name>
  <description>Test Folder in User Library Updated</description>
</documentfolder>

Response

HTTP/1.1 204 No Content

JSON Example

Request

PUT http://webexsocialserver/api/quad/rest/documentfolders/1010011
Accept:application/json
Content-Type: application/json
 
   
Request Payload :
{ 
  "description" : "Test Folder in User Library Updated",
  "name" : "Test Folder by User Updated"
}

Response

HTTP/1.1 204 No Content

Delete the Designated Document Folder

Purpose

Deletes the designated document folder.

Availability

Cisco WebEx Social 3.0 and later.

Request

HTTP Method
URI

DELETE

http://server[:port_number]/api/quad/rest/documentfolders/folder_id


where:

server

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

port_number

Cisco WebEx Social server port number that is used for communication with the API consumer. Must be provided if the port number is not 80.

folder_id

Identifier of the document folder to delete. 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/documentfolders/468185

Response

HTTP/1.1 204 No Content