Loading ...

REST API: Get Files | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Files » REST API: Get Files
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 14

REST API: Get Files

0 
 /5
0 (0votes)

Get Files List

GET /api/files

Get a list of files. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
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.
Optional Parameters How to use Description
FileDirectoryID &FileDirectoryID=x - Used in the request URL as a query parameter ID of the file directory from which list of files are to be returned.
Status &Status=x - Used in the request URL as a query parameter Status of the content. Here are the values of Entity Status parameter:
  • PendingWorkflow = 0
  • Published = 1
  • Draft = 2
  • Declined = 3
  • Updated = 4
  • Expired = 5
  • Spam = 6
  • All = 7
  • DelayedPublishing = 8
  • TemporarilySaved = 9
  • UnderProcessing = 10
  • Deleted = 11
SortColumn &SortColumn=x - Used in the request URL as a query parameter Sort content based on a column. Here are the values of Sort Column parameter:
  • Unspecified = 0
  • DateCreated = 1
  • Rating = 2
  • DatePublished = 3
  • DateUpdated = 4
  • ViewCount = 5
  • CommentCount = 6
  • EventStartDate = 7
  • SortOrder = 8
  • VoteCount = 9
  • ContentTitle = 10
  • DateAwarded = 11
  • TagCount = 12
  • MostRelavant = 13
SortType &SortType=x - Used in the request URL as a query parameter The order in which content is to be sorted. Here are the values of Sort Type parameter:
  • Ascending =0
  • Descending = 1
  • Unspecified = 2
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x -Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET https://myintranet.communifire.com/api/files?FileDirectoryID=362&Status=1&SortColumn=1&SortType=0&StartPage=1&PageLength=100

Example Response

Content JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
    [
        {
            "ContentID":2349,
            "EntityType":14,
            "ContentTypeID":14,
            "ContentTitle":"windows.png",
            "ContentStub":"windows-png",
            "ContentBody":"",
            "ContentBodyUnprocessed":"",
            "ContentSummary":"",
            "AuthorID":1,
            "AuthorUserName":"john",
            "UpdatedByUserID":1,
            "UpdatedByUserDisplayName":"John Smith",
            "UpdatedByUserUsername":"john",
            "UpdatedByUserEmail":"acme565@acme.com",
            "UpdatedByUserFirstName":"John",
            "UpdatedByUserLastName":"Smith",
            "UpdatedByUserAvatarImageUrl":"https://myintranet.communifire.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
            "UpdatedByUserProfileUrl":"https://myintranet.communifire.com//people/john",
            "ParentContentID":362,
            "ContentVersionID":1,
            "SpaceID":0,
            "WorkflowID":0,
            "CurrentWorkflowStepID":0,
            "StatusID":1,
            "DateCreated":"2016-02-09T09:32:14.29",
            "DatePublished":"2016-02-09T09:32:14.293",
            "DateUpdated":"2016-02-09T09:32:14.29",
            "IsFeatured":false,
            "ViewCount":0,
            "CommentCount":0,
            "Rating":0.0,
            "MetaTitle":"windows.png",
            "MetaDescription":"",
            "MetaKeywords":"",
            "ContentMediaServerID":3,
            "ContentMediaFileName":"0172f146-a1a1-4110-afa5-e1a6dcf61ee6.png",
            "ContentMediaServerRootURL":"https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
            "AuthorDisplayName":"John Smith",
            "AuthorEmail":"acme@acme.com",
            "AuthorFirstName":"John",
            "AuthorLastName":"Smith",
            "AuthorAvatarImageUrl":"https://myintranet.communifire.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
            "AuthorProfileUrl":"https://myintranet.communifire.com//people/john",
            "IsLatest":false,
            "DateCreatedString":"20 minutes ago",
            "DatePublishedString":"20 minutes ago",
            "DateUpdatedString":"20 minutes ago",
            "ContentURL":"/files/2349/windows-png",
            "ContentVersionURL":"",
            "ParentContentTitle":"Logos",
            "ParentContentURL":"/files?directoryid=362",
            "ContentFileSize":1075.0,
            "ContentFileSizeString":"1KB",
            "IsEditable":true,
            "IsDeletable":true,
            "IsDownloadable":true,
            "IsChekoutable":false,
            "IsUndochekoutable":false,
            "IsChekinable":false,
            "IsRestoreable":false,
            "IsPurgeable":false,
            "IsHistoryViewable":true,
            "IsMoveable":true,
            "ContentMediaOnlineViewUrl":"/files/view/2349",
            "ContentMediaUrl":"/fileattachment?file=Bll%2FQDhKrdFuntbrlVyy4w%3D%3D&v=1",
        },
        {
            "ContentID":2350,
            "EntityType":14,
            "ContentTypeID":14,
            "ContentTitle":"gates.png",
            "ContentStub":"gates-png",
            "ContentBody":"",
            "ContentBodyUnprocessed":"",
            "ContentSummary":"",
            "AuthorID":1,
            "AuthorUserName":"john",
            "UpdatedByUserID":1,
            "UpdatedByUserDisplayName":"John Smith",
            "UpdatedByUserUsername":"john",
            "UpdatedByUserEmail":"acme565@acme.com",
            "UpdatedByUserFirstName":"John",
            "UpdatedByUserLastName":"Smith",
            "UpdatedByUserAvatarImageUrl":"https://myintranet.communifire.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
            "UpdatedByUserProfileUrl":"https://myintranet.communifire.com//people/john",
            "ParentContentID":362,
            "ContentVersionID":1,
            "SpaceID":0,
            "WorkflowID":0,
            "CurrentWorkflowStepID":0,
            "StatusID":1,
            "DateCreated":"2016-02-09T09:32:17.363",
            "DatePublished":"2016-02-09T09:32:17.367",
            "DateUpdated":"2016-02-09T09:32:17.363",
            "IsFeatured":false,
            "ViewCount":0,
            "CommentCount":0,
            "Rating":0.0,
            "MetaTitle":"caution.png",
            "MetaDescription":"",
            "MetaKeywords":"",
            "ContentMediaServerID":3,
            "ContentMediaFileName":"9524436b-ede6-4596-b2e3-f5e5d139e071.png",
            "ContentMediaServerRootURL":"https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
            "AuthorDisplayName":"John Smith",
            "AuthorEmail":"acme@acme.com",
            "AuthorFirstName":"John",
            "AuthorLastName":"Smith",
            "AuthorAvatarImageUrl":"https://myintranet.communifire/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
            "AuthorProfileUrl":"https://myintranet.communifire.com//people/john",
            "IsLatest":false,
            "DateCreatedString":"20 minutes ago",
            "DatePublishedString":"20 minutes ago",
            "DateUpdatedString":"20 minutes ago",
            "ContentURL":"/files/2350/gates-png",
            "ContentVersionURL":"",
            "IsPublishedFromDraftMode":false,
            "IsPublishedFromDelayedPublishingMode":false,
            "ParentContentTitle":"Nostrum consequatur laboriosam velit saepe voluptatibus officiis labore eius.",
            "ParentContentURL":"/files?directoryid=362",
            "IsPublishedFromUnderProcessingMode":false,
            "IsWallContent":false,
            "ContentFileSize":1075.0,
            "ContentFileSizeString":"1KB",
            "IsEditable":true,
            "IsDeletable":true,
            "IsDownloadable":true,
            "IsChekoutable":false,
            "IsUndochekoutable":false,
            "IsChekinable":false,
            "IsRestoreable":false,
            "IsPurgeable":false,
            "IsHistoryViewable":true,
            "IsMoveable":true,
            "ContentMediaOnlineViewUrl":"/files/view/2350",
            "ContentMediaUrl":"/fileattachment?file=1Tu76lyuaT6No5jHjZuO2A%3D%3D&v=1"
        }
    ]
}


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

 

Wiki Index

Pages

Intranet Software