Skip to main content

Instance

Instance#

Instance - the basic entity of the survey that is created based on a template.
It is a non-mutable object, if after the creation of the instance the template has changed, the state of the instance will not change


AttributeTypeDescriptionNullable
idStringIdentifierfalse
templateIdStringIdentifier of templatefalse
typeString Type of instance:
STANDALONE - if instance is quick
TASK - if instance create by survey task
true
dimensionsObjectmeasured value (e.g. value from a catalog)true
questionIdsStringList of question id included in the instance true
sumGradeResultIntegerAmount of points scoredfalse
maxGradeResultIntegerMaximum number of points that the user could gainfalse
percentGradeResultIntegerpercentage of survey completionfalse
executorIdDictionary of stringsIdentifier of executortrue
creationDateDate and timeDate and time when the survey was createdtrue
updateAtDate and timeDate and time when the survey was updatedtrue
finishedBooleanIndicates the completion of the survey true
Example:
[
{
"id": "5ed768ced812710006cebef4",
"templateId": "5ed26636d812710006ce93d3",
"type": "TASK",
"dimensions": [],
"questionIds": [
"5ed26894d812710006ce93dc",
"5ed268d9d812710006ce93e2",
"5ed5397ad812710006ce9c83",
"5ed26817d812710006ce93d9",
"5ed26d20d812710006ce93fc",
"5ed26e62d812710006ce9400",
"5ed26eaad812710006ce9404",
"5ed26f08d812710006ce9408",
"5ed26f65d812710006ce940c",
"5ed26f9cd812710006ce940d",
"5ed26fafd812710006ce940e",
"5ed26fefd812710006ce940f",
"5ed27014d812710006ce9410",
"5ed27073d812710006ce9411",
"5ed27082d812710006ce9412",
"5ed270c8d812710006ce9413",
"5ed270d3d812710006ce9414"
],
"sumGradeResult": 0,
"maxGradeResult": 0,
"percentGradeResult": 0,
"tenant": "yourCompany",
"executorId": -1,
"creationDate": "2020-09-07T17:24:17.343",
"updateAt": "2020-06-03T09:15:18.924",
"finished": false
}
]