Get Information about the Current Version of a Document File

Returns information about the current version of a document file.

Request
GET

http://<webexsocial-server>/api/quad/rest/documents/{document_id}

Authentication Required

Supported since version 3.0 

Example Request and Response
Request Response 
GET /api/quad/rest/documents/910126 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.57 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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US

            
HTTP/1.1 200 OK
Date: Fri, 13 Jul 2012 17:22:29 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 433
Content-Type: application/json;charset=UTF-8 
{
    "statusCode": 200,
    "startIndex": 0,
    "itemsPerPage": 1,
    "totalResults": 1,
    "filtered": false,
    "sorted": false,
    "entry": [{
        "data": {
            "author": {
                "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": "",
            "fileName": "DLFE-100001.pdf",
            "folderId": 10374,
            "id": 910126,
            "mimeType": "DOCUMENT",
            "published": 1342043393807,
            "readCount": 5,
            "resource": "http://quad.cisco.com/schema/1.0/document",
            "size": 13901495,
            "tags": [],
            "title": "XML",
            "updated": 1342043393807,
            "updatedBy": {
                "firstName": "Test",
                "fullName": "Test Test",
                "id": 10260,
                "images": [],
                "jobTitle": "",
                "lastName": "Test",
                "resource": "http://quad.cisco.com/schema/1.0/user",
                "screenName": "test",
                "status": "ACTIVE"
            },
            "uri": "/c/document_library/get_file?folderId=10374&name=DLFE-100001.pdf&version=1.0",
            "version": 1.0
        }
    }],
    "serverMessages": null
}

Get Information about the Designated Version of a Document File

Returns information about the specified version of a file.

Request
GET

http://<webexsocial-server>/api/quad/rest/documents/{dpcument_id}/versions/{version}

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
GET /api/quad/rest/documents/910126/versions/1.0 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.57 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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US


            

HTTP/1.1 200 OK
Date: Fri, 13 Jul 2012 17:31:55 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 433
Content-Type: application/json;charset=UTF-8 
{
    "statusCode": 200,
    "startIndex": 0,
    "itemsPerPage": 1,
    "totalResults": 1,
    "filtered": false,
    "sorted": false,
    "entry": [{
        "data": {
            "author": {
                "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": "",
            "fileName": "DLFE-100001.pdf",
            "folderId": 10374,
            "id": 910126,
            "mimeType": "DOCUMENT",
            "published": 1342043393807,
            "readCount": 5,
            "resource": "http://quad.cisco.com/schema/1.0/document",
            "size": 13901495,
            "tags": [],
            "title": "XML",
            "updated": 1342043393807,
            "updatedBy": {
                "firstName": "Test",
                "fullName": "Test Test",
                "id": 10260,
                "images": [],
                "jobTitle": "",
                "lastName": "Test",
                "resource": "http://quad.cisco.com/schema/1.0/user",
                "screenName": "test",
                "status": "ACTIVE"
            },
            "uri": "/c/document_library/get_file?folderId=10374&name=DLFE-100001.pdf&version=1.0",
            "version": 1.0
        }
    }],
    "serverMessages": null
}

Get Information about All Versions of a Document File

Returns information for all versions of a specified file

Request
GET

http://<webexsocial-server>/api/quad/rest/documents/{document_id}/versions

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
GET /api/quad/rest/documents/910126/versions 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.57 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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US

            
HTTP/1.1 200 OK
Date: Fri, 13 Jul 2012 17:35:34 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 472
Content-Type: application/json;charset=UTF-8 
{
    "statusCode": 200,
    "startIndex": 0,
    "itemsPerPage": 2,
    "totalResults": 2,
    "filtered": false,
    "sorted": false,
    "entry": [{
        "data": {
            "author": {
                "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": "",
            "fileName": "DLFE-100001.pdf",
            "folderId": 10374,
            "id": 910126,
            "mimeType": "DOCUMENT",
            "published": 1342043393807,
            "readCount": 5,
            "resource": "http://quad.cisco.com/schema/1.0/document",
            "size": 5162003,
            "tags": [],
            "title": "XMLV2",
            "updated": 1342200902050,
            "updatedBy": {
                "firstName": "Test",
                "fullName": "Test Test",
                "id": 10260,
                "images": [],
                "jobTitle": "",
                "lastName": "Test",
                "resource": "http://quad.cisco.com/schema/1.0/user",
                "screenName": "test",
                "status": "ACTIVE"
            },
            "uri": "/c/document_library/get_file?folderId=10374&name=DLFE-100001.pdf&version=1.1",
            "version": 1.1
        }
    }, {
        "data": {
            "author": {
                "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": "",
            "fileName": "DLFE-100001.pdf",
            "folderId": 10374,
            "id": 1110001,
            "mimeType": "DOCUMENT",
            "published": 1342043393807,
            "readCount": 5,
            "resource": "http://quad.cisco.com/schema/1.0/document",
            "size": 13901495,
            "tags": [],
            "title": "XMLV2",
            "updated": 1342200902050,
            "updatedBy": {
                "firstName": "Test",
                "fullName": "Test Test",
                "id": 10260,
                "images": [],
                "jobTitle": "",
                "lastName": "Test",
                "resource": "http://quad.cisco.com/schema/1.0/user",
                "screenName": "test",
                "status": "ACTIVE"
            },
            "uri": "/c/document_library/get_file?folderId=10374&name=DLFE-100001.pdf&version=1.0",
            "version": 1.0
        }
    }],
    "serverMessages": null
}

Upload a Document File

Uploaded the attached file. Must include the folder_id in the request payload. Ex: folder_id: 1037

Request
POST

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

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
POST /api/quad/rest/documents?folderid=10374 HTTP/1.1
Host: 192.168.168.160
Content-Length: 1400
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.57 Safari/536.11
Content-Type: multipart/form-data; boundary=----WebKitFormBoundarySChfg8tfhhiS1vpf
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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US 
            
{
    "statusCode": 200,
    "startIndex": 0,
    "itemsPerPage": 1,
    "totalResults": 1,
    "filtered": false,
    "sorted": false,
    "entry": [{
        "data": {
            "id": 1110011,
            "resource": "http://quad.cisco.com/schema/1.0/document",
            "size": 1101,
            "published": 1342207527748,
            "updated": 1342207527748,
            "fileName": "DLFE-200002.java",
            "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-200002.java&version=1.0",
            "version": 1.0,
            "title": "Serial",
            "description": "",
            "folderId": 10374,
            "readCount": 0,
            "tags": []
        }
    }],
    "serverMessages": null
}

Update information about a file

Updates information about the specified file. include the folder_id in the request payload. Ex: folder_id: 1037

Request
PUT

http://<webexsocial-server>/api/quad/rest/documents/{document_id}

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
PUT /api/quad/rest/documents/1110011?folderid=10374&title=Updated HTTP/1.1
Host: 192.168.168.160
Content-Length: 1499
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.57 Safari/536.11
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryd8yNqnsOjMnBLqLS
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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US 
            
HTTP/1.1 204 No Content
Date: Fri, 13 Jul 2012 19:33:31 GMT
Server: Apache
Content-Length: 0
Content-Type: text/plain; charset=UTF-8

Delete the Designated Version of a Document File

Deletes the specified version of a file.

Request
DELETE

http://<webexsocial-server>/api/quad/rest/documents/{document_id}/versions/1.0

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
DELETE /api/quad/rest/documents/910126/versions/1.0 HTTP/1.1
Host: 192.168.168.160
Content-Length: 54
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.57 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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US 

            
HTTP/1.1 204 No Content
Date: Fri, 13 Jul 2012 19:37:28 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json;charset=UTF-8

Delete all Versions of a Document File

Delete all versions of a file.

Request
DELETE

http://<webexsocial-server>/api/quad/rest/documents/{document_id}

Authentication Required

Supported since version 3.0

Example Request and Response
Request Response 
DELETE /api/quad/rest/documents/910126 HTTP/1.1
Host: 192.168.168.160
Content-Length: 54
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.57 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=10D9DE576A34244A060D2898E37D2895.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US 
          

HTTP/1.1 204 No Content
Date: Fri, 13 Jul 2012 19:42:01 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json;charset=UTF-8