Related Questionnaire with Rest API

Using Evotix 360’s Rest API, Questionnaires can be created in line with the parent record.

  • The Questionnaire component must be enabled for the REST API to use this feature.
  • All examples below assume that the base URL for the REST API is http://<WebApp URL>/restapi
  • Refer to Simplified Questionnaire JSON Examples for examples of simplified JSON structure.

Step

Example

GET list of available questionnaire templates

CALL Type: GET

URL Example:

http://<WebApp URL>/restapi/component/questionnaire_template

This returns the list of enabled questionnaire templates in simplified JSON format. Each template follows this structure:

{
"unique_id": 'Unique Id of Questionnaire Template record',
"name": "Questionnaire Template Name",
"enabled": true,
"template": "{Simplified Questionnaire JSON}"
"keyword": "Questionnaire Template keyword"
}

 

GET call to filter questionnaire templates using keyword or name or Unique ID

Filter Questionnaire Templates by Keyword, Name, or Unique ID

CALL Type: GET

URL Example:

http://<WebApp URL>/restapi/component/questionnaire_template?$filter=keyword eq 'Inspection'

http://<WebApp URL>/restapi/component/ questionnaire_template?$filter=name eq '7 Point Fire Check'

http://<WebApp URL>/restapi/component/questionnaire_template('UniqueId of Questionnaire Template record')

GET related questionnaire for a record

Retrieves the questionnaire linked to a record.

CALL Type: GET

URL Example:

http://<WebApp URL>/restapi/component/inspections? $expand= rel_inspection_checklist

http://<WebApp URL>/restapi/component/inspections ('UniqueId of Inspection Record')? $expand= rel_inspection_checklist

GET a specific questionnaire record

Retrieve a specific questionnaire record.

CALL Type: GET

URL (example):

http://<WebApp URL>/E360/restapi/component/questionnaire ('UniqueId of Questionnaire Record')

CREATE a related questionnaire inline

Create a related questionnaire record.

CALL Type: POST

URL Example:

http://<WebApp URL>/E360/restapi/component/inspection

Payload Example:{

"inspection_summary": "7 Point Fire Check Inspection",
"inspection_date": "2026-01-20",
"inspection_type": "Safety",
"rel_inspection_checklist": {
"name": "7 Point Fire Check",
"json": "{Simplified Questionnaire JSON}"
}

UPDATE a related questionnaire record

To update a related questionnaire record

CALL Type: PATCH

URL Example:

http://<WebApp URL>/E360/restapi/component/questionnaire ('UniqueId of Questionnaire Record')

Payload Example:

{
"name": "7 Point Fire Check",

"json": "{Simplified Questionnaire JSON}"
}

 

UPDATE a related questionnaire record with a different questionnaire

To update a related questionnaire record with a different questionnaire

CALL Type: PATCH

URL Example:

http://<WebApp URL>/E360/restapi/component/questionnaire ('UniqueId of Questionnaire Record')

Payload Example:

{
"name": "7 Point Fire Check"
}

 

Note:
Updating to a different questionnaire requires providing the template name.To also update the results, send a second PATCH call with the updated JSON.

UPDATE a related questionnaire record with the latest questionnaire template

To update a related questionnaire record with the latest questionnaire template and/or clear out the result/answers

CALL Type: PATCH

URL Example:

http://<WebApp URL>/E360/restapi/component/questionnaire ('UniqueId of Questionnaire Record')

Payload Example:

{

"name": "7 Point Fire Check"

}

note_awesome

Unsupported Operations

  • POST and PATCH call for Questionnaire Template.
  • POST for creating a questionnaire record directly.
  • PATCH for updating a questionnaire inline within the parent record.

In This Section

Attachments in Questionnaire with Rest API

Simplified Questionnaire JSON Examples

Examples

Troubleshooting

See Also

Rest API

Rest API - Introduction

Add Components to Rest API

Generate an API Key for a User

GET (Read) Operations

PATCH (Write) Operations

POST (Create) Operations

CREATE or UPDATE Users with Rest API

CREATE DBFiles/Files with Rest API