Get Information about a Document Folder

Returns information about a specified folder

Note: Document is associated with uploaded files in the library. File is associated with files uploaded to posts.

Request
GET

http://<webexsocial-server>/api/quad/rest/documentfolders/{folder_id}

Authentication Required

Supported since version 3.0 

Example Request and Response
Request Response 
GET /api/quad/rest/documentfolders/10374 HTTP/1.1
Host: 192.168.168.160
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
User-Agent: Mozilla/5.0 (Windows NT 6.1) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.47 Safari/536.11
Content-Type: application/json
Accept: application/json
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3
Cookie: COOKIE_SUPPORT=true; JSESSIONID=EF18C90E30E7ED8DBEE31D147145E8B8.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US 

            
HTTP/1.1 200 OK
Date: Thu, 12 Jul 2012 20:50:33 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 638
Content-Type: application/json;charset=UTF-8

{
    "statusCode": 200,
    "startIndex": 0,
    "itemsPerPage": 1,
    "totalResults": 1,
    "filtered": false,
    "sorted": false,
    "entry": [{
        "data": {
            "createDate": 1337297817537,
            "creator": {
                "firstName": "Test",
                "fullName": "Test Test",
                "id": 10260,
                "images": [],
                "jobTitle": "",
                "lastName": "Test",
                "resource": "http://quad.cisco.com/schema/1.0/user",
                "screenName": "test",
                "status": "ACTIVE"
            },
            "description": "",
            "documents": [{
                "id": 910126,
                "resource": "http://quad.cisco.com/schema/1.0/document",
                "size": 13901495,
                "published": 1342043393807,
                "updated": 1342043393807,
                "fileName": "DLFE-100001.pdf",
                "mimeType": "DOCUMENT",
                "author": {
                    "id": 10260,
                    "resource": "http://quad.cisco.com/schema/1.0/user",
                    "manager": null,
                    "firstName": "Test",
                    "lastName": "Test",
                    "fullName": "Test Test",
                    "screenName": "test",
                    "images": [],
                    "startWorkHour": 0,
                    "endWorkHour": 0,
                    "timeZone": "America/Los_Angeles",
                    "jobTitle": "",
                    "friendlyJobTitle": null,
                    "addresses": null,
                    "emails": null,
                    "phones": null,
                    "tags": null,
                    "customAttributes": null,
                    "status": "ACTIVE",
                    "legalHold": "NOHOLD"
                },
                "updatedBy": {
                    "id": 10260,
                    "resource": "http://quad.cisco.com/schema/1.0/user",
                    "manager": null,
                    "firstName": "Test",
                    "lastName": "Test",
                    "fullName": "Test Test",
                    "screenName": "test",
                    "images": [],
                    "startWorkHour": 0,
                    "endWorkHour": 0,
                    "timeZone": "America/Los_Angeles",
                    "jobTitle": "",
                    "friendlyJobTitle": null,
                    "addresses": null,
                    "emails": null,
                    "phones": null,
                    "tags": null,
                    "customAttributes": null,
                    "status": "ACTIVE",
                    "legalHold": "NOHOLD"
                },
                "uri": "/c/document_library/get_file?folderId=10374&name=DLFE-100001.pdf&version=1.0",
                "version": 1.0,
                "title": "XML",
                "description": "",
                "folderId": 10374,
                "readCount": 3,
                "tags": []
            }],
            "id": 10374,
            "lastModifiedDate": 1337297817537,
            "name": "Documents",
            "parentFolderId": 0,
            "resource": "http://quad.cisco.com/schema/1.0/documentfolder"
        }
    }],
    "serverMessages": null
}

Create a Document Folder

Returns the created folder with specified information

Request
POST

http://<webexsocial-server>/api/quad/rest/documentfolders

{
"description" : "Test Folder in User Library",
"name" : "Test Folder by User"
}

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
HTTP/1.1 201 Created
Date: Thu, 12 Jul 2012 19:26:34 GMT
Server: Apache
Location: http://192.168.168.160/quadopen/api/rest/documentfolders/1010004
Content-Encoding: gzip
Content-Length: 339
Content-Type: application/json;charset=UTF-8 
            
HTTP/1.1 200 OK
Date: Thu, 12 Jul 2012 20:50:33 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 638
Content-Type: application/json;charset=UTF-8

{
    "statusCode": 200,
    "startIndex": 0,
    "itemsPerPage": 1,
    "totalResults": 1,
    "filtered": false,
    "sorted": false,
    "entry": [{
        "data": {
            "createDate": 1342121195596,
            "creator": {
                "firstName": "Test",
                "fullName": "Test Test",
                "id": 10260,
                "images": [],
                "jobTitle": "",
                "lastName": "Test",
                "resource": "http://quad.cisco.com/schema/1.0/user",
                "screenName": "test",
                "status": "ACTIVE"
            },
            "description": "Test Folder in User Library",
            "id": 1010004,
            "lastModifiedDate": 1342121195596,
            "name": "Test Folder by User",
            "parentFolderId": 0,
            "resource": "http://quad.cisco.com/schema/1.0/documentfolder"
        }
    }],
    "serverMessages": null
}

Update Information about a Document Folder

Updates a specified folder's information. Returns code 204 as success.

Request
PUT

http://<webexsocial-server>/api/quad/rest/documentfolders/{folder_id}

{
"description" : "Test Folder in User Library Updated",
"name" : "Test Folder by User Updated"
}

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
PUT /api/quad/rest/documentfolders/1010004 HTTP/1.1
Host: 192.168.168.160
Content-Length: 100
Origin: chrome-extension://cokgbflfommojglbmbpenpphppikmonn
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
User-Agent: Mozilla/5.0 (Windows NT 6.1) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.47 Safari/536.11
Content-Type: application/json
Accept: application/json
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3
Cookie: COOKIE_SUPPORT=true; JSESSIONID=EF18C90E30E7ED8DBEE31D147145E8B8.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US
{ 
"description" : "Test Folder in User Library Updated", 
"name" : "Test Folder by User Updated"
}

            
HTTP/1.1 204 No Content
Date: Thu, 12 Jul 2012 19:35:45 GMT
Server: Apache
Content-Length: 0
Content-Type: text/plain; charset=UTF-8

Delete a Folder

Deletes the specified folder. Returns code 204 for success.

Request
DELETE

http:///<webexsocial-server>/api/quad/rest/documentfolders/{folder_id}

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
DELETE /api/quad/rest/documentfolders/1010004 HTTP/1.1
Host: 192.168.168.160
Content-Length: 0
Origin: chrome-extension://cokgbflfommojglbmbpenpphppikmonn
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
User-Agent: Mozilla/5.0 (Windows NT 6.1) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.47 Safari/536.11
Content-Type: application/json
Accept: application/json
Accept-Encoding: gzip,deflate,sdch
Accept-Language: en-US,en;q=0.8
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3
Cookie: COOKIE_SUPPORT=true; JSESSIONID=EF18C90E30E7ED8DBEE31D147145E8B8.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US 


            
HTTP/1.1 204 No Content
Date: Thu, 12 Jul 2012 19:41:30 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json;charset=UTF-8