This function returns a list of files contained in a specified folder.

Resource Information

Method

URL

Required authentication

POST

/V1/CMDB/Files/

Yes

Parameters

Name

Description

Token*required
(header)

The token can be obtained by sending a POST request to the log in session endpoint and provide valid credentials.

Body*required
(body)

The body contains the following parameters:

▪folderid (string): The ID of the folder from which you want to get the files. Return the root folder (Public) if folderid is null.

▪fileTypes*(array): the file types you want to retrieve. There are three file types:

▪0: Folder

▪11: Map

▪21: Dashboard

Example:

{
"folderId": "",
"fileTypes": [ 0, 11 ,21]
}

Response

Parameter

Type

Description

Example

items

array

A list of folders and files.

{
    "items": [
         {  
            "originalId":"75ff3cdf-dff4-48c6-a736-7a86e4374a29",
            "id":"ad09aa07-b31d-4f42-a0aa-319697825b09",
            "name":"Public/Site Maps",
            "type":0
        },
         {
            "originalId":"75ff3cdf-dff4-48c6-a736-7a86e4374a29",
            "id":"2a19165f-a4a5-4488-ac5d-acdf9e287ed6",
            "name":"Public/New Folder/New Folder/New Map",
            "type":11
        },
         {
            "originalId":"d2650deb-5276-44cb-be21-43e2b129380a",
            "id":"a84cdca3-3710-47b1-b037-665e38fd6d08",
            "name":"Public/New Folder(1)/New Map",
            "type":11
        }
    ],
    "statusCode":790200,
    "statusDescription":"Success."
}

id

string

The ID of a folder in the file tree.

name

string

The name of a file.

originalId

string

The ID of a specific dashboard or file.

(Used for Map or Dashboard type only.)

type

integer

The type of a file.

▪0: Folder

▪11: Map

▪21: Dashboard