Loading ...

REST API: Add Attachment | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Add Attachment
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 10

REST API: Add Attachment

0 
 /5
0 (0votes)

Add Attachment

POST /api/content/{ContentID}/attachments

Add a attachment to content. List of supported entities: Articles, Blogs, Events, Forum Topics, Forum Posts, Ideas, Videos, Wikis. 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.
ContentID Used in the request URL as a path parameter Unique identifier of the content to add the attachment to.
EntityTypeID &EntityTypeID=x - Used in the request URL as a query parameter Required parameter for events - set to 5. Optional parameter for all other content types.
AttachmentType &AttachmentType=x - Used in the request URL as a query parameter

Attachment types:
1- Attachment
2- Editor image

Example Request

POST http://myintranet.communifire.com/api/content/30/attachments?EntityTypeID=5&AttachmentType=1

Example Response

File JSON object is returned as ResponseData.

{
    "IsError": false,
    "ResponseData": [
        {
            "FileID": 6,
            "FileExtension": "txt",
            "Description": "Article attachment file",
            "Caption": "file.txt",
            "FileName": "29958060-156a-435d-9abe-2cb6b9ed5cac.txt",
            "MediaServerID": 3,
            "FileHeight": 0,
            "FileWidth": 0,
            "EntityID": 30,
            "EntityType": 3,
            "FileSize": 7,
            "Active": true,
            "DateCreated": "2018-04-23T22:25:52.0985283Z",
            "IsImage": false,
            "AttachmentType": 1,
            "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