<< Back to GForge REST API

Entity: Docman

GET

getBinary

Get raw file contents. URL: /api/docman/[file-id]/binary?version=[version-number]

Parameters (3)

Name Type Description
id int Unique identifier for the file object. This is part of the URL route
version int (Optional) number of the version being requested. Defaults to the current version.
open mixed (Optional) If any non-"falsy" value is included, open the binary content in the browser. Otherwise, download as a file.

Return: (none)

No return type is defined

getBundle

Retrieves a folder with its contents (files and versions)

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: \api\DocmanFolderDetail

No return type is defined

getFile

Retrieves a file with its file versions and folders

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: \api\DocmanFileDetail

No return type is defined

getFolder

Retrieves a folder with its contents (files and versions)

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: \api\DocmanFolderDetail

No return type is defined

getFolders

Retrieves all folders on a given project

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: \api\DocmanFolderBasic[]

Zero or more DocmanFolderBasic objects

POST

postBinary

Processes a binary file upload

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: array

Array with API location to attachment

postFile

Updates a file

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined

postFolder

Retrieves all folders on a given project

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: \api\DocmanFolderBasic[]

Zero or more DocmanFolderBasic objects

postVersion

Updates a file version

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined

PUT

DELETE

deleteFile

Deletes a file version

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined

deleteFolder

Deletes a folder, and subfolders and files in them

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined

deleteVersion

Deletes a file version

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined