Skip to content

Designed
Get questionnaire template (questions)

Request

Design-time view of a published questionnaire template: its questions, their codes, value types, options and dependencies. Templates are created by Professional Services through the application. Fetched once per template at integration time — the question codes are the keys of the answers document.

Security
oauth2(Required scopes: t1_api)
Path
questionnaireTemplateIdstring, (uuid)required

The unique identifier of the questionnaire template

curl -i -X GET \
  'https://apis.traceone.com/spec/v2/questionnaire-templates/{questionnaireTemplateId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the questionnaire template

Bodyapplication/json
questionnaireTemplateIdstring, (uuid)read-only
namestring
questionnaireTypestring

What the instances are answered for — a specification, an ingredient declaration term, or a packaging component

Enum:"Specification""IngredientDeclarationTerm""PackagingComponent"
chapterTypestring

The chapter the instances attach to when linked

Enum:"general""production""conditioning""packaging""testing""finishedProduct""labelling"
languageCodestring

The template's language; question texts and option labels are in it when translated

questionsArray of objects(QuestionnaireQuestion)

Every question, dependent questions included, in answers-schema order

Response
{
  "questionnaireTemplateId": "0b02396b-5760-44b0-bf4d-5b234211ce5b",
  "name": "string",
  "questionnaireType": "Specification",
  "chapterType": "general",
  "languageCode": "string",
  "questions": [
    { … }
  ]
}