REST API: Check Out File

Anonymous User

Published: 5/5/2015

Grace Kamau

Updated: 2/25/2021

0 (0votes)

Check Out File

Check out a file to lock it for updating. Valid for Communifire version 5.2 and above.

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.
ContentID	Used in the request body	Unique identifier for a particular file, which has to be checked out.

Body:

A status message is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"2343",
    "ResponseData":"File checked out successfully"
}

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