Loading ...

REST API: Add Case Comment Attachment | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Case Comments » REST API: Add Case Comment Attachment
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 6

REST API: Add Case Comment Attachment

0 
 /5
0 (0votes)

Add Case Comment Attachment

POST /api/cases/{CaseID}/comments/{CommentID}/attachments

Adds an attachment to a case comment. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
File Stream Used in the request body Send the byte stream of the file you want to upload.
CaseID Used in the request URL as a path parameter Unique identifier of the case the comment is for.
CommentID Used in the request URL as a path parameter Unique identifier of the case comment to add the attachment to.
SpaceID &SpaceID=x - Used in the request URL as a query parameter Unique ID of the space.

Example Request

POST https://myintranet.communifire.com/api/cases/476/comments/2/attachments?SpaceID=3

Example Response

File JSON is returned as ResponseData.

{
   "IsError": false,
   "ResponseData": [
      {
         "AttachmentType": 1,
         "FileID": 6,
         "FileExtension": "pdf",
         "Description": "IssueComment attachment file",
         "Caption": "Health-Benefits-Guide-for-Employees.pdf",
         "FileName": "5f5681ff-63c5-4e35-83cf-4c1ed3673409.pdf",
         "MediaServerID": 3,
         "EntityID": 2,
         "EntityType": 20,
         "FileSize": 1100399,
         "Active": true,
         "DateCreated": "2020-06-26T20:09:42.5821681Z",
         "IsImage": false,
         "TenantID": 1
      },
      {
         "AttachmentType": 1,
         "FileID": 7,
         "FileExtension": "pdf",
         "Description": "IssueComment attachment file",
         "Caption": "Which Dental Plan is Right for You.pdf",
         "FileName": "cd7baf3e-f76e-4ab4-a4b6-86b1ddb8d060.pdf",
         "MediaServerID": 3,
         "EntityID": 2,
         "EntityType": 20,
         "FileSize": 395094,
         "Active": true,
         "DateCreated": "2020-06-26T20:09:42.5852055Z",
         "IsImage": false,
         "TenantID": 1
      }
   ],
}

Please Note The content type that you pass in the header of your request should be multipart/form-data or application/octet-stream. Multipart allows multiple files to be uploaded in a single request.

Wiki Index

Pages

Intranet Software