Skip to content

Limited
Get questionnaire instance (questions & answers)

Request

Reads one questionnaire instance at its own address: its questions (stable id, text, description, type, options) and the current answers. Symmetric with PUT .../answers. Template-type agnostic — also serves packaging questionnaires, whose ids are exposed by the packaging chapter reads. Unanswered questions carry a null answer; a value is never fabricated.

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

The unique identifier of the questionnaire instance

Query
languageCodestring

Language for question texts, descriptions and option labels. Defaults to the questionnaire's own language.

curl -i -X GET \
  'https://apis.traceone.com/spec/v2/questionnaires/{questionnaireId}?languageCode=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returns the questionnaire with its answers

Bodyapplication/json
questionnaireIdstring, (uuid)read-only
questionnaireTemplateIdstring, (uuid)
namestring or null
chapterTypestring

Chapter placement, derived from the template: general, production, finishedProduct, labelling (packaging templates add their own types)

languageCodestring
isLockedboolean

True once a linked specification entered signature — answers can no longer be written

associatedMaterialIdstring or null, (uuid)
associatedPackagingComponentIdstring or null, (uuid)
questionsArray of objects(QuestionnaireQuestionWithAnswer)
Response
{
  "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  "questionnaireTemplateId": "0b02396b-5760-44b0-bf4d-5b234211ce5b",
  "name": "string",
  "chapterType": "string",
  "languageCode": "string",
  "isLocked": true,
  "associatedMaterialId": "802cdde7-0f75-4aae-aac0-11c53638ce02",
  "associatedPackagingComponentId": "95425432-aba1-4738-9689-8e73e4189a22",
  "questions": [
    { … }
  ]
}