Skip to main content
API docs by Redocly

Endatix API (v0)

Download OpenAPI specification:Download

Forms

Create a new submission

Creates a new form submission

path Parameters
formId
required
integer <int64>

The ID of the form for which the submission is made.

Request Body schema: application/json
required
isComplete
boolean or null

Boolean flag to indicate if a submission is complete. Optional

currentPage
integer or null <int32>

Current page if the form has multiple pages. Optional

jsonData
required
string >= 2 characters

Stringified form submission data

metadata
string or null

Stringified metadata related to the form submission

Responses

Request samples

Content type
application/json
{
  • "isComplete": true,
  • "currentPage": 0,
  • "jsonData": "string",
  • "metadata": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isComplete": true,
  • "jsonData": "string",
  • "formDefinitionId": "string",
  • "currentPage": 0,
  • "metadata": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Get a list of Submissions for a given form

Returns all submissions for a form given formId. Includes all Form Definitions as well as complete and non-complete responses

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

query Parameters
page
integer or null <int32>

The number of the page

pageSize
integer or null <int32>

The number of items to take.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a single submission

Get a single submission based of its Id and its respective formId

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

submissionId
required
integer <int64>

The ID of the form submission.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "isComplete": true,
  • "jsonData": "string",
  • "formDefinitionId": "string",
  • "currentPage": 0,
  • "metadata": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Update a form submission

Updates a form submission for a given form.

path Parameters
formId
required
integer <int64>

The ID of the form for which the submission is made.

submissionId
required
integer <int64>

The ID the submission that will be updated

Request Body schema: application/json
required
jsonData
string or null >= 2 characters

Stringified form submission data

isComplete
boolean or null

Boolean flag to mark the form completion status

currentPage
integer or null <int32> > 0

The current page of the form

metadata
string or null

Stringified metadata related to the form submission

Responses

Request samples

Content type
application/json
{
  • "jsonData": "string",
  • "isComplete": true,
  • "currentPage": 0,
  • "metadata": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isComplete": true,
  • "jsonData": "string",
  • "formDefinitionId": "string",
  • "currentPage": 0,
  • "metadata": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Update a form submission

Updates a form submission for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form for which the submission is made.

submissionId
required
integer <int64>

The ID the submission that will be updated

Request Body schema: application/json
required
jsonData
required
string >= 2 characters

Stringified form submission data

isComplete
boolean or null

Boolean flag to mark the form completion status

currentPage
integer or null <int32> > 0

The current page of the form

metadata
string or null

Stringified metadata related to the form submission

Responses

Request samples

Content type
application/json
{
  • "jsonData": "string",
  • "isComplete": true,
  • "currentPage": 0,
  • "metadata": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isComplete": true,
  • "jsonData": "string",
  • "formDefinitionId": "string",
  • "currentPage": 0,
  • "metadata": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Create a new form

Creates a new form and an active form definition for it.

Authorizations:
JWTBearerAuth
Request Body schema: application/json
required
name
required
string [ 2 .. 100 ] characters

The name of the form.

description
string or null

The description of the form.

isEnabled
required
boolean non-empty

Indicates if the form is enabled.

formDefinitionJsonData
required
string >= 2 characters

The JSON data of the active form definition.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "isEnabled": true,
  • "formDefinitionJsonData": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isEnabled": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

List forms

Lists all forms with optional pagination.

Authorizations:
JWTBearerAuth
query Parameters
page
integer or null <int32>

The number of the page

pageSize
integer or null <int32>

The number of items to take.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new form definition

Creates a new form definition for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

Request Body schema: application/json
required
isDraft
required
boolean non-empty

Indicates if the form definition is a draft.

jsonData
required
string >= 2 characters

The JSON data of the form definition.

isActive
required
boolean non-empty

Indicates if the form definition is active.

Responses

Request samples

Content type
application/json
{
  • "isDraft": true,
  • "jsonData": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

List form definitions

Lists all form definitions for a given form with optional pagination.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

query Parameters
page
integer or null <int32>

The number of the page

pageSize
integer or null <int32>

The number of items to take.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get the active form definition

Gets the active form definition for a given form.

path Parameters
formId
required
integer <int64>

The ID of the form.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Partially update the active form definition

Partially updates the active form definition for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

Request Body schema: application/json
required
isDraft
boolean or null

Indicates if the form definition is a draft.

jsonData
string or null

The JSON data of the form definition.

isActive
boolean or null

Indicates if the form definition is active.

Responses

Request samples

Content type
application/json
{
  • "isDraft": true,
  • "jsonData": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Update the active form definition

Updates the active form definition for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

Request Body schema: application/json
required
isDraft
required
boolean non-empty

Indicates if the form definition is a draft.

jsonData
required
string non-empty

The JSON data of the form definition.

isActive
required
boolean non-empty

Indicates if the form definition is active.

Responses

Request samples

Content type
application/json
{
  • "isDraft": true,
  • "jsonData": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Get a form definition by ID

Gets a form definition by its ID for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

definitionId
required
integer <int64>

The ID of the form definition.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Partially update a form definition

Partially updates a form definition for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

definitionId
required
integer <int64>

The ID of the form definition.

Request Body schema: application/json
required
isDraft
boolean or null

Indicates if the form definition is a draft.

jsonData
string or null

The JSON data of the form definition.

isActive
boolean or null

Indicates if the form definition is active.

Responses

Request samples

Content type
application/json
{
  • "isDraft": true,
  • "jsonData": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Update a form definition

Updates a form definition for a given form.

Authorizations:
JWTBearerAuth
path Parameters
formId
required
integer <int64>

The ID of the form.

definitionId
required
integer <int64>

The ID of the form definition.

Request Body schema: application/json
required
isDraft
required
boolean non-empty

Indicates if the form definition is a draft.

jsonData
required
string non-empty

The JSON data of the form definition.

isActive
required
boolean non-empty

Indicates if the form definition is active.

Responses

Request samples

Content type
application/json
{
  • "isDraft": true,
  • "jsonData": "string",
  • "isActive": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "isDraft": true,
  • "jsonData": "string",
  • "formId": "string",
  • "isActive": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Auth

Login endpoint

Authenticates an user based of valid credentials and returns JWT token

Request Body schema: application/json
required
email
required
string <email> non-empty ^[^@]+@[^@]+$

Email of the user. Must be a valid email address

password
required
string >= 8 characters

Password of the account

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "stringst"
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "token": "string"
}