- Previous: Folder Options API
- Up: Overview
- Next: UI Integration Framework
Project Folder API
The Project Folder API allows you to search, create, modify, and delete Project folders
Common HTTP Headers
Header | Description | Value |
---|---|---|
Content-Type | Specifies the format of the request body | application/json |
Authorization | Requires the OAuth token you obtained through the OAuth flow | Bearer {OAuth token} |
Error | Description |
---|---|
200 | Successful operation |
403 | User is not authorized |
404 | Item not found |
Get All Projects
This endpoint is used to list all project folders in the domain.
GET/pubapi/v1/project-folders
Create Project
This endpoint is used to create a project.
POST/pubapi/v1/project-folders
Request Parameters
Parameter | Description | Required | Possible Values |
---|---|---|---|
rootFolderId | FolderId of the root project folder | Yes | string |
name | The name of the project | Yes | string |
description | Folder description | No | string |
status | Status of the project | Yes | pending, in-progress, completed, on-hold, or canceled |
startDate | The start date of the project. | No | string |
completionDate | The completion date for the project. | No | string |
Sample Request Body
{ "rootFolderId": "5bd7337c-b303-46a0-938d-0365352a5c74", "name": "Egnyte's new project, Mountain View, CA", "description": "Project description goes here", "status": "pending", "startDate": "2022-05-01T12:37:56.000+0000", "completionDate": "2022-11-05T12:37:56.000+0000" }
Find Project by Id
This endpoint is used to retrieve a project based on its Id.
GET/pubapi/v1/project-folders/{project-id}
Sample Response Body
{ "id": "af911e83-1c2e-4764-b709-08e64319baaf", "rootFolderId": "5bd7337c-b303-46a0-938d-0365352a5c74", "name": "Egnyte's new project, Mountain View, CA", "description": "project description", "status": "pending", "completionDate": "2022-11-05T12:37:56.000+0000", "createdBy": 103, "lastUpdatedBy": 103, "creationTime": "2021-11-05T12:37:56.000+0000", "lastModifiedTime": "2022-05-02T12:39:14.000+0000" }
Find Project by root folder id
This endpoint is used to retrieve a project based on the id of the root folder.
POST/pubapi/v1/project-folders/search
Request Parameters
Parameter | Description | Required | Possible Values |
---|---|---|---|
rootFolderId | The id of the root folder | Yes | string |
Sample Response Body
[ { "id": "af911e83-1c2e-4764-b709-08e64319baaf", "rootFolderId": "5bd7337c-b303-46a0-938d-0365352a5c74", "name": "Egnyte's new project, Mountain View, CA", "description": "project description", "status": "pending", "completionDate": "2022-11-05T12:37:56.000+0000", "createdBy": 103, "lastUpdatedBy": 103, "creationTime": "2021-11-05T12:37:56.000+0000", "lastModifiedTime": "2022-05-02T12:39:14.000+0000" } ]
Remove a Project
This endpoint is used to remove a project.
DELETE/pubapi/v1/project-folders/{project-id}
Update an Existing Project
This endpoint is used to update an existing project.
PATCH/pubapi/v1/project-folders/{project_id}
Request Parameters
All parameters here are optional, but at least one parameter must be specified.
Parameter | Description | Required | Possible Values |
---|---|---|---|
name | The name of the project | No | string |
description | Folder description | No | string |
status | Status of the project | No | pending, in-progress, completed, on-hold, or canceled |
startDate | The start date of the project. | No | string |
completionDate | The completion date for the project. | No | string |
Sample Request Body
{ "name": "Egnyte's new project, Mountain View, CA", "description": "Project description goes here", "status": "pending", "startDate": "2022-05-01T12:37:56.000+0000", "completionDate": "2022-11-05T12:37:56.000+0000" }
Clean up project
This endpoint is used to clean up a project.
POST/pubapi/v1/project-folders/{project_id}/cleanup
Request Parameters
Parameter | Description | Required | Possible Values |
---|---|---|---|
deleteLinks | If set to true, all existing active links in the project will be deleted | Yes | boolean (true, false) |
usersToDelete | List of User Ids to be deleted | No | List of User Ids |
usersToDisabed | List of User Ids to be disabled | No | List of User Ids |
Return codes
Return Code | Description |
---|---|
202 | Cleanup procedure started |
409 | The previous cleanup procedure is still in progress. |
503 | Too many cleanup procedures are being executed. The server can not accept the request at the moment. |
Sample Request Body
{ "deleteLinks": true, "usersToDelete": [ 0 ], "usersToDisable": [ 0 ] }
- Previous: Folder Options API
- Up: Overview
- Next: UI Integration Framework
Docs Navigation
- Overview
- Getting Started
- Authentication
- File System API
- Permissions API
- Events API
- Search API
- Links API
- Workflow API
- User Management API
- Group Management API
- Audit Reporting API v2
- Trash API
- Comments API
- Metadata API
- Embedded UI API
- Bookmarks API
- User Insights API
- Folder Options API
- Project Folder API
- UI Integration Framework
- Best Practices
- Mobile Development
- Other Applications
- Webhooks
- Protect API
- Audit Reporting API V1