Projects
- 23 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Projects
- Updated on 23 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
GET /projects/{id}/alerts
Returns a list of subscription alerts.
No Parameters.
POST /projects/{id}/alerts/{eventId}
Subscribe a user to a project alert.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The project id. |
| eventId* | Guid | The event id. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| usId* | Guid | UsId of the associated user. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
DELETE /projects/{id}/alerts/{eventId}
Unsubscribe a user from an alert.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The project id. |
| eventId* | Guid | The event id. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| usId* | Guid | UsId of the associated user. |
Response Codes
| Code | Description |
|---|---|
| 404 | Not Found |
| 400 | Bad Request |
GET /Projects/{id}/GetFormRelatedProjects
Get the related projects for a form.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The project id. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| status | String | Form release status.
|
| q | String | A VisualVault REST API Data Query. |
GET /Projects/{id}/GetFormProjects
Get the projects for a form.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The project id. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| status | String | Form release status.
|
| q | String | A VisualVault REST API Data Query. |
GET /Projects/{mtiId}/CustomProjectsList
Get a custom filtered project list.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| mtiId* | Guid | The menu tab item id. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| q | String | A VisualVault REST API Data Query. |
| sortField | String | Field name to sort by. |
| sortDir | String | Sort direction.
|
| pageSize* | String | Number of entries for each dashboard page. Default = 15. |
| startPage* | String | Page to start the search. |
POST /Projects/NewFormProject
Create a new form project.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| formId | Guid | The form ID if this call originates from an Upload Button form control. |
| projectName* | String | The name of the project. |
| projectDescription* | String | The project description. |
| security* | Int | Project security mode.
|
| copyProjectId* | Guid | ID of the project to copy. |
PUT /Projects/DeleteProject
Delete a project.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| pjid* | String | ID of the associated project. |
PUT /Projects/AssociateFormToProject
Associate a form to a project.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| formId* | Guid | The form ID if this call originates from an Upload Button form control. |
| pjid* | String | ID of the associated project. |
PUT /Projects/RemoveFormToProjectAssociation
Remove a form from a project.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| formId* | Guid | The form ID if this call originates from an Upload Button form control. |
| pjid* | String | ID of the associated project. |
Was this article helpful?
