Loading ...

REST API: Get Space Directories | Communifire Documentation

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

REST API: Get Space Directories

0 
 /5
0 (0votes)

Get Space Directories

GET /api/spaces/{SpaceID}/file/directories/{ParentDirectoryID}

Get a list of directories based on the space ID and parent directory ID. 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.
ParentID Used in the request URL as a path parameter

 ID of the parent directory whose child directories are to be returned.
SpaceID Used in the request URL as a path parameter ID of the space whose directories are to be returned.

Example Request

GET https://myintranet.communifire.com/api/spaces/235/file/directories/336

Example Response

Directories JSON object is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
        [
            {
                "DirectoryID":456,
                "DirectoryName":"Tutorials",
                "ParentID":336,
                "UserID":1,
                "SpaceID":235,
                "MediaServerID":0,
                "IsDeleted":false,
                "IsRenamable":false,
                "IsDeletable":false,
                "IsSubDirectoryCreatable":false,
                "CanCreateFile":false,
                "IsSync":false
            },
            {
                "DirectoryID":457,
                "DirectoryName":"Icons",
                "ParentID":336,
                "UserID":1,
                "SpaceID":235,
                "MediaServerID":0,
                "IsDeleted":false,
                "IsRenamable":false,
                "IsDeletable":false,
                "IsSubDirectoryCreatable":false,
                "CanCreateFile":false,
                "IsSync":false
            },
            {
                "DirectoryID":458,
                "DirectoryName":"Reasearch",
                "ParentID":336,
                "UserID":1,
                "SpaceID":235,
                "MediaServerID":0,
                "IsDeleted":false,
                "IsRenamable":false,
                "IsDeletable":false,
                "IsSubDirectoryCreatable":false,
                "CanCreateFile":false,
                "IsSync":false
            }
}


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

 

Wiki Index

Pages

Intranet Software