API ReferenceForms

Create Project Form

Create a new form instance in a project. Notes: - `templateId` is required. - `phaseInstanceId` is optional, but if provided the referenced phase must be started (active) for creation to succeed.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

projectIdstringRequired
Project identifier

Request

This endpoint expects an object.
templateIdintegerRequired
Template to use for the form
phaseInstanceIdintegerOptional

Optional. Phase instance id where the form will be created (phase must be started). You can gather phase instance ids from the Get Project endpoint.

Response

Form created successfully
idinteger or null
Created element instance identifier
phaseInstanceIdinteger or null
projectIdinteger or null
typestring or null
statusstring or null
formobject or null

Optional. Form record when returned by project-service.

Errors