Projects
  • 23 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Projects

  • Dark
    Light

Article summary


 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
ParameterTypeDescription
id*GuidThe project id.
eventId*GuidThe event id.
Query Parameters
ParameterTypeDescription
usId*GuidUsId of the associated user.
Response Codes
CodeDescription
400Bad Request


 DELETE   /projects/{id}/alerts/{eventId}


Unsubscribe a user from an alert.

Route Parameters
ParameterTypeDescription
id*GuidThe project id.
eventId*GuidThe event id.
Query Parameters
ParameterTypeDescription
usId*GuidUsId of the associated user.
Response Codes
CodeDescription
404Not Found
400Bad Request


 GET   /Projects/{id}/GetFormRelatedProjects


Get the related projects for a form.

Route Parameters
ParameterTypeDescription
id*GuidThe project id.
Query Parameters
ParameterTypeDescription
statusStringForm release status.
  • unreleased
  • released
  • both
qStringA VisualVault REST API Data Query.


 GET   /Projects/{id}/GetFormProjects


Get the projects for a form.

Route Parameters
ParameterTypeDescription
id*GuidThe project id.
Query Parameters
ParameterTypeDescription
statusStringForm release status.
  • unreleased
  • released
  • both
qStringA VisualVault REST API Data Query.


 GET   /Projects/{mtiId}/CustomProjectsList


Get a custom filtered project list. 

Route Parameters
ParameterTypeDescription
mtiId*GuidThe menu tab item id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.
sortFieldStringField name to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
pageSize*StringNumber of entries for each dashboard page. Default = 15.
startPage*StringPage to start the search.


 POST   /Projects/NewFormProject


Create a new form project.

Body Parameters
ParameterTypeDescription
formIdGuidThe form ID if this call originates from an Upload Button form control.
projectName*StringThe name of the project.
projectDescription*StringThe project description.
security*IntProject security mode.
  • FolderSecurity (0)
  • ProjectSecurity (1)
copyProjectId*GuidID of the project to copy.


 PUT   /Projects/DeleteProject


Delete a project.

Body Parameters
ParameterTypeDescription
pjid*StringID of the associated project.


 PUT   /Projects/AssociateFormToProject


Associate a form to a project.

Body Parameters
ParameterTypeDescription
formId*GuidThe form ID if this call originates from an Upload Button form control.
pjid*StringID of the associated project.


 PUT   /Projects/RemoveFormToProjectAssociation


Remove a form from a project.

Body Parameters
ParameterTypeDescription
formId*GuidThe form ID if this call originates from an Upload Button form control.
pjid*StringID of the associated project.

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence