forms

Create Project Form

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.
post/projects/{project_id}/forms

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/projects/{project_id}/forms
  • Auth: API key in header x-api-key

Path parameters

project_idinteger required

Project identifier

Request body

templateIdinteger required

Template to use for the form

phaseInstanceIdinteger

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

Created form identifier

templateIdinteger
phaseInstanceIdinteger
projectIdinteger
typestring
statusstring
namestring
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.