Create Project Form | Coperniq API

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.

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

projectIdintegerRequired

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

Created element instance identifier

phaseInstanceIdinteger

projectIdinteger

typestring

statusstring

formobject

Optional. Form record when returned by project-service.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/projects/1/forms';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"templateId":1}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1,
3	"phaseInstanceId": 1,
4	"projectId": 1,
5	"type": "string",
6	"status": "string",
7	"form": {
8	"id": 1,
9	"name": "string",
10	"status": "string",
11	"createdAt": "2024-01-15T09:30:00Z",
12	"updatedAt": "2024-01-15T09:30:00Z"
13	}
14	}