File Resource Operations Summary

Transcription

1 CHAPTER 13 This chapter describes the Cisco WebEx Social API File resource operations. These operations let you upload to the Cisco WebEx Social server a text or binary file (which you can later embed in or attach to a post), obtain information about these files, and delete these files from the Cisco WebEx Social server. Table 13-1 provides a summary of the File resource operations. Each operation is described in detail in the section that is listed. These sections provide this information: Brief explanation of the operation Availability Cisco WebEx Social releases that support the operation HTTP method and URI for the operation Payload Description of the request payload, if the operation requires one Description of the expected response when the operation executes Example Sample request and response for the operation Table 13-1 Summary Operation and Reference Get Information about a File, page 13-2 Upload a File, page 13-4 Delete a File, page 13-6 Retrieves information about the designated file Uploads to the Cisco WebEx Social server the image to be embedded in a post or the file to be attached to a post or micropost Deletes the designated file from the Cisco WebEx Social server 13-1

2 Get Information about a File Chapter 13 Get Information about a File Retrieves information about the designated file. Availability Cisco WebEx Social 3.4 and later. HTTP Method GET URI http 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. file_id Identifier of the file for which to retrieve information. For information about obtaining the identifier that you need, see the Identifiers of Cisco WebEx Social Entities section on page Payload A request payload is not required. Standard response (see the API s section on page 1-18) with a response payload that can include one File resource (the File Resource section on page 3-29 describes this resource). Example GET Accept:application/json HTTP/ OK Content-Type: application/json "statuscode": 200, "startindex": 0, "itemsperpage": 1, "totalresults": 0, "filtered": false, "sorted": false, "entry": [ "data": "id": 3344, "resource": "", "size": 27571, "published": , "updated": , 13-2

3 Chapter 13 Get Information about a File "filename": " retro-apple-tv.jpg", "mimetype": "IMAGE", "author": null, "uri": "/image/image_gallery?img_id= &attachmentid= " ], "servermessages": null 13-3

4 Upload a File Chapter 13 Upload a File Uploads to the Cisco WebEx Social server the image to be embedded in a post or the file to be attached to a post or a micropost. Availability Cisco WebEx Social 3.4 and later. HTTP Method POST URI http 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. filname Name of a file that overrides the file that is specified in the request payload. The filename parameter is required if you are using Internet Explorer to send this API operation. Payload File to be uploaded. The HTTP Content-Type header must be multipart/form-data for this request. The form-data key must be specified as file=file_to_upload. If you are uploading a video file, single-sign on (SSO) must be enabled in Cisco WebEx Social before you execute this operation. Standard response (see the API s section on page 1-18) with a response payload that can include one File resource (the File Resource section on page 3-29 describes this resource). Example POST accept: application/json content-length: expect: 100-continue content-type: multipart/form-data; boundary= a4bb521c a4bb521c19 Content-Disposition: form-data; name="file"; filename="profilephoto.jpg" <binary_file> HTTP/ Created Location: Content-Length: 597 Content-Type: application/json HTTP/ OK 13-4

5 Chapter 13 Upload a File "statuscode": 200, "startindex": 0, "itemsperpage": 1, "totalresults": 0, "filtered": false, "sorted": false, "entry": [ "data": "id": 3344, "resource": "", "size": 27571, "published": , "updated": , "filename": "ProfilePhoto.jpg", "mimetype": "IMAGE", "author": null, "uri": "/image/image_gallery?img_id= &attachmentid= " ], "servermessages": null 13-5

6 Delete a File Chapter 13 Delete a File Deletes the designated file from the Cisco WebEx Social server. The file also is deleted from the posts that it is attached to or embedded in. Availability Cisco WebEx Social 3.4 and later. HTTP Method DELETE URI http 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. file_id Identifier of the file to delete. For information about obtaining the identifier that you need, see the Identifiers of Cisco WebEx Social Entities section on page Payload A request payload is not required. Standard response (see the API s section on page 1-18) with an HTTP header only. Example DELETE HTTP/ No Content 13-6