Loading ...

REST API: Update File Directory | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Files » REST API: Update File Directory
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 15

REST API: Update File Directory

0 
 /5
0 (0votes)

Update File Directory

PUT /api/file/directories/{DirectoryID}

Update a file directory. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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.
DirectoryID Used in the request URL as a path parameter Unique identifier for a particular file directory.
File Directory JSON Used in the request body This is JSON that represents a file directory object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
DirectoryName Used in the request body Name of the file directory to be updated.
ParentID Used in the request body Directory ID of the directory to set as the parent.

Example Request

PUT https://myintranet.communifirecom/api/file/directories/327

Body:

"{
    \"DirectoryName\":\"Maths discussions\"
}"
Note: Stringify your JSON data.

Example Response

True/false is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"Directory renamed successfully",
    "ResponseData":327
}

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software