3.2 - 3.8 - REST API Designer - Process File Manager

Process File Manager Endpoints

The following are the methods currently implemented for the process file manager resources of the designer in the ProcessMaker API.

Process File Manager resources:

Name	Description	Type	Value
prj_uid	Project UID	String	String of 32 characters
prf_uid	File UID	String	String of 32 characters
prf_path	Path name	String	"public/.../..." or "templates/.../..."
path	Path name	String	"public/.../..." or "templates/.../..."
prf_filename	File name	String	String
content	File content	String	String
usr_uid	UID of the user who created the document	String	String
prg_update_usr_uid	UID of the user who updated the document	String	String
prf_type	Registry type	String	String. It can be a file or folder.
prf_editable	Indicates if the registry is editable	String	String
prf_create_date	Document creation date	Date	Date
prf_update_date	Document update date	Date	Date
prf_content	Document content	String	String
prf_derivation_screen	Returns "true" if the template is used as a routing screen of a task or process. Otherwise, returns "false".	String	true|false

Get Files List: GET project/{prj_uid}/file-manager?path={path}

Gets a list of the files in a project.

GET /api/1.0/{workspace}/project/{prj_uid}/file-manager?path={path}

Function: doGetProcessFileManager()

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Parameter:

Name	Type	Description
path	String	File path. For example: "templates" to retrieve only the process's templates.

Result:

Type	Description
array	Returns an array of objects containing information about the files

Example:

Response

Create file: POST project/{prj_uid}/file-manager

Creates a file in the File Manager.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/file-manager

Function: doPostProcessFilesManager()

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Required Fields:

Name	Type	Description
prf_path	String	Path name
prf_filename	String	File name
content	String	File content

Result:

Type	Description
object	Returns an object containing information about the new file.

Example:

Request

Response

Update the File Content: PUT project/{prj_uid}/file-manager/{prf_uid}

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

PUT /api/1.0/{workspace}/project/{prj_uid}/file-manager/{prf_uid}

Function: (doPutProcessFileManager)

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
prf_uid	String	File UID

Required Fields:

Name	Type	Description
content	String	File content

Result:

Type	Description
object	Returns an object containing information about the file

Example:

Request

Response

Upload a Document: POST project/{prj_uid}/file-manager/{prf_uid}/upload

Uploads a document to the File Manager.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/file-manager/{prf_uid}/upload

Function: (doPostProcessFilesManagerUpload)

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
prf_uid	String	File UID

Result:

Type	Description
empty	No return

Example:

Response

Upload Files: POST project/{prj_uid}/file-manager/{prf_uid}/upload

Available Version: As of ProcessMaker 3.4.0.

Upload and validate files to the Templates and Public Files directory.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

POST /api/1.0/{workspace}/project/{prj_uid}/process-files-manager/{main_path}

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
main_path	String	templates or public

Result:

Type	Description
empty	No return

Example:

Response

Download a Document: GET project/{prj_uid}/file-manager/{prf_uid}/download

Downloads a document.

GET /api/1.0/{workspace}/project/{prj_uid}/file-manager/{prf_uid}/download

Function: (doGetProcessFilesManagerDownload)

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
prf_uid	String	File UID

Result:

Type	Description
empty	No return

Example:

Response

Delete a Document of a File: DELETE project/{prj_uid}/file-manager/{prf_uid}

Deletes a document from the file manager.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

DELETE /api/1.0/{workspace}/project/{prj_uid}/file-manager/{prf_uid}

Function: (doDeleteProcessFilesManager)

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
prf_uid	String	File UID

Result:

Type	Description
empty	No return

Example:

Response

Delete a File from the Project: DELETE project/{prj_uid}/file-manager/folder?path={path}

Deletes the content of a folder.

Permission:

Users must have the PM_FACTORY permission assigned to their role to perform this action.

Structure:

DELETE /api/1.0/{workspace}/project/{prj_uid}/file-manager/folder?path={path}

Function: (doDeleteFolderProcessFilesManager)

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID

Optional Parameter:

Name	Type	Description
path	String	File path

Result:

Type	Description
empty	No return

Example:

Response

List a Single File: GET project/{prj_uid}/file-manager/{prf_uid}

Gets the information of a single file.

GET /api/1.0/{workspace}/project/{prj_uid}/file-manager/{prf_uid}

Function: (doGetProcessFileManager)

Parameters:

Name	Type	Description
workspace	String	Workspace name
prj_uid	String	Project UID
prf_uid	String	File UID

Result:

Type	Description
object	Returns an object

Example:

Response