Create Project Form | Coperniq API

Create a new form instance in a project.

Notes:

templateId is required.
The form is created using its template’s name. name is not accepted here — use PATCH /forms/{form_id} to rename it afterward.
phaseInstanceId is optional, but if provided the referenced phase must be started (active) for creation to succeed.

Create a new form instance in a project. Notes: - `templateId` is required. - The form is created using its template's name. `name` is not accepted here — use `PATCH /forms/{form_id}` to rename it afterward. - `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

project_idintegerRequired

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

idintegerOptional

Created form identifier

templateIdintegerOptional

phaseInstanceIdintegerOptional

projectIdintegerOptional

typestringOptional

statusstringOptional

namestringOptional

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error