Form

This API is unofficial

The resources described below are not part of our open API. They are made available to select customers/partners only. Please do not spread this documentation to third parties without consent from Coredination.

The Form object

A form is essentially a collection of custom fields. Currently, forms are only visible in the Coredination applications as attachments on jobs.

Example

{
	"id": 123456,
	"title": "Service checklist",
	"description": "Monthly service of TL-4XXX pumps",
	"instructions": "Check all boxes, note any discrepancies, sign at the bottom.",
	"fields": [
		// a bunch of custom fields...
	],
	"uuid": "987e0667-209f-48c8-8444-e8fad49c7860",
}

States

A completely filled-out form has a state of COMPLETED. A form that is partially filled-out (missing values on required fields) has a state of STARTED. A form that is saved but not filled-out (no values in fields) has a state of PUBLISHED. The state is automatically set by the backend.

Get a form

Get a specific form by ID or UUID. The form will typically be referenced from a job.

Example

GET /form/2039077

Response

A form object.

Method: GET
URL: /form/:id
Authentication: Token
Response: Form object

Create a form

Create a form. The form will be assigned a server-generated ID and UUID. Currently, forms should be attached to a job (using the jobUuid or jobId property), as that is the only thing that makes sense in the applications.

Example

POST /form

{
	"title": "My fantastic form",
	"description": "A form created with the API",
	"jobUuid": "449f140c-e578-441e-acea-f37e4810e6c1",
	"fields": [
		// ... custom fields ...
	]
}

Response

The created form object.

Method: POST
URL: /form
Authentication: Token
Request: Form object
Response: Form object

Update or create a form

Update an existing form or create it (if it doesn't exist and :id is a UUID).

Example

PUT /form/0847ed17-b060-4599-a38c-be9a8b9cbb34

{
	"fields": [
		// ... custom fields ...
	],
}

Response

The updated form object.

Method: PUT
URL: /form/:id
Authentication: Token
Request: Form object
Response: Form object

Delete a form

Delete a form.

Example

DELETE /form/0847ed17-b060-4599-a38c-be9a8b9cbb34

Method: DELETE
URL: /form/:id
Authentication: Token
Response: Status code only

Get form templates

Example

GET /form/templates

Response

List of form objects.

Method: GET
URL: /form/templates
Authentication: Token
Response: List of Form