❔
Sunbird inQuiry
  • LEARN
    • Overview
    • Capabilities
    • Components
    • Technical Architecture
    • Product & Developer Guide
      • Quick Starter Guide
        • inQuiry Components
          • Editor
          • Player
          • inQuiry Service
      • Question & Question Set Editor
        • Architecture
        • Features
        • Configuration
        • Source Code
        • APIs
        • FAQ's
      • Question & Question Set Service
        • Architecture
        • Features
        • Schema
          • Question Schema
          • QuestionSet Schema
        • APIs
          • V1
            • Question API's
              • Create Question
              • Read Question
              • Read Private Question
              • Update Question
              • Submit for Review Question
              • Publish Question
              • Retire Question
              • Question List
              • Import Question
              • Copy Question
              • Reject Question
            • QuestionSet API's
              • Create QuestionSet
              • Update QuestionSet
              • Read QuestionSet
              • Read Private QuestionSet
              • Review QuestionSet
              • Reject QuestionSet
              • Publish QuestionSet
              • Retire QuestionSet
              • Update Hierarchy QuestionSet
              • Read QuestionSet Hierarchy
              • Import QuestionSet
              • Copy QuestionSet
          • V2
            • Question API's
              • Create Question
              • Read Question
              • Read Private Question
              • Update Question
              • Submit for Review Question
              • Reject Question
              • Publish Question
              • Copy Question
              • Import Question
              • Question List
              • Retire Question
            • QuestionSet API's
              • Create QuestionSet
              • Read QuestionSet
              • Read Private QuestionSet
              • Update QuestionSet
              • Review QuestionSet
              • Reject QuestionSet
              • Publish QuestionSet
              • Update Hierarchy QuestionSet
              • Read QuestionSet Hierarchy
              • Import QuestionSet
              • Copy QuestionSet
              • Retire QuestionSet
        • Configuration
        • Source Code
        • FAQs
      • Question Set Player
        • Architecture
        • Configuration
        • Source Code
        • APIs
        • FAQ's
      • Analytics
      • Code Coverage Stats
    • 🚀Product Roadmap
  • ENGAGE
    • Discuss
  • Use
    • Overview
    • Developer Installation
      • Question & Question Set Service
        • Installation
        • Configuration
      • Question Set Editor
        • Installation
          • Object Category Definition
          • Sample Form Configuration
      • Question set Player
        • Installation
    • Release Plan & Calendar
      • Release calendar 5.2.0, 5.3.0, 5.4.0, 5.5.0, 5.6.0
      • Release calendar 5.7.0, 6.0.0,6.1.0 and 6.2.0
    • Release notes
      • inQuiry - Release v8.0.0 (Ongoing)
      • inQuiry - Release v7.0.0 (Latest)
      • inQuiry - Release v6.2.0
      • inQuiry - Release v6.1.0
      • inQuiry - Release v6.0.0
      • inQuiry - Release v5.7.0
      • inQuiry - Release v5.6.0
      • inQuiry - Release v5.5.0
      • inQuiry - Release v5.4.0
      • inQuiry - Release v5.3.0
      • inQuiry - Release v5.2.0
      • inQuiry - Release v5.1.0
      • inQuiry - Release v5.0.0
      • inQuiry - Release V 4.10.0
      • inQuiry - Release V 4.9.0
      • inQuiry - Release V 4.8.0
      • inQuiry - Release V 4.7.0
    • Deprecations
      • Release-5.6.0 (upcoming)
      • Release-5.5.0
    • Learn More
      • Dependencies
      • Delete User Functionality
        • User PII Cleanup
        • Asset Ownership Transfer
  • Guidelines or Best practices
    • Testing QA guidelines
    • Developer coding guidelines
  • Archived
    • Use Cases
    • Components
    • Server Installation
    • Capabilities
Powered by GitBook
On this page
  • schema.json:
  • config.json:

Was this helpful?

Edit on GitHub
  1. LEARN
  2. Product & Developer Guide
  3. Question & Question Set Service
  4. Schema

Question Schema

schema.json:

{
  "$id": "question-schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Question",
  "type": "object",
  "required": [
    "name",
    "code",
    "mimeType",
    "primaryCategory"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 5
    },
    "code": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "mimeType": {
      "type": "string",
      "enum": [
        "application/vnd.sunbird.question"
      ]
    },
    "primaryCategory": {
      "type": "string"
    },
    "additionalCategories": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "visibility": {
      "type": "string",
      "default": "Default",
      "enum": [
        "Default",
        "Parent",
        "Private",
        "Protected"
      ]
    },
    "copyright": {
      "type": "string"
    },
    "license": {
      "type": "string",
      "default": "CC BY 4.0"
    },
    "lockKey": {
      "type": "string"
    },
    "assets": {
      "type": "array"
    },
    "audience": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "Student",
          "Teacher",
          "Administrator",
          "Parent"
        ],
        "default": "Student"
      }
    },
    "author": {
      "type": "string"
    },
    "owner": {
      "type": "string"
    },
    "attributions": {
      "type": "array"
    },
    "consumerId": {
      "type": "string"
    },
    "contentEncoding": {
      "type": "string",
      "enum": [
        "gzip",
        "identity"
      ],
      "default": "gzip"
    },
    "contentDisposition": {
      "type": "string",
      "enum": [
        "inline",
        "online",
        "attachment",
        "online-only"
      ],
      "default": "inline"
    },
    "appIcon": {
      "type": "string",
      "format": "url"
    },
    "publishChecklist": {
      "type": "array"
    },
    "publishComment": {
      "type": "string"
    },
    "compatibilityLevel": {
      "type": "number",
      "default": 4
    },
    "status": {
      "type": "string",
      "enum": [
        "Draft",
        "Review",
        "Live",
        "Retired"
      ],
      "default": "Draft"
    },
    "prevState": {
      "type": "string"
    },
    "prevStatus": {
      "type": "string"
    },
    "lastStatusChangedOn": {
      "type": "string"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "pkgVersion": {
      "type": "number"
    },
    "version": {
      "type": "number",
      "default": 1
    },
    "versionKey": {
      "type": "string"
    },
    "language": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "English",
          "Hindi",
          "Assamese",
          "Bengali",
          "Gujarati",
          "Kannada",
          "Malayalam",
          "Marathi",
          "Nepali",
          "Odia",
          "Punjabi",
          "Tamil",
          "Telugu",
          "Urdu",
          "Sanskrit",
          "Maithili",
          "Other"
        ]
      },
      "default": ["English"]
    },
    "languageCode": {
      "type": "array"
    },
    "channel": {
      "type": "string"
    },
    "framework": {
      "type": "string"
    },
    "subject" : {
      "type": "array"
    },
    "medium" : {
      "type": "array"
    },
    "board" : {
      "type": "string"
    },
    "gradeLevel" : {
      "type": "array"
    },
    "topic" : {
      "type": "array"
    },
    "boardIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "gradeLevelIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "subjectIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "mediumIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "topicsIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetFWIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetBoardIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetGradeLevelIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetSubjectIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetMediumIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "targetTopicIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_FWIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_boardIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_subjectIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_mediumIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_topicIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_gradeLevelIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_boards": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_subjects": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_mediums": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_topics": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "se_gradeLevels": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "createdOn": {
      "type": "string"
    },
    "createdFor": {
      "type": "array"
    },
    "createdBy": {
      "type": "string"
    },
    "artifactUrl": {
      "type": "string",
      "format": "url"
    },
    "lastUpdatedOn": {
      "type": "string"
    },
    "lastUpdatedBy": {
      "type": "string"
    },
    "lastSubmittedOn": {
      "type": "string"
    },
    "lastSubmittedBy": {
      "type": "string"
    },
    "publisher": {
      "type": "string"
    },
    "lastPublishedOn": {
      "type": "string"
    },
    "lastPublishedBy": {
      "type": "string"
    },
    "publishError": {
      "type": "string"
    },
    "reviewError": {
      "type": "string"
    },

    "body": {
      "type": "string",
      "description": "External Property"
    },
    "editorState": {
      "type": "object",
      "description": "External Property"
    },
    "answer": {
      "type": "string",
      "description": "External Property"
    },
    "solutions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "External Property"
    },
    "instructions": {
      "type": "object",
      "description": "External Property"
    },
    "hints": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "External Property"
    },
    "media": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "External Property"
    },
    "responseDeclaration": {
      "type": "object",
      "description": "External Property"
    },
    "interactions": {
      "type": "object",
      "description": "External Property"
    },


    "qType": {
      "type": "string",
      "enum": [
        "MCQ",
        "FTB",
        "SA"
      ]
    },
    "scoringMode": {
      "type": "string",
      "enum": [
        "system",
        "none"
      ]
    },
    "qumlVersion": {
      "type": "number"
    },
    "timeLimit": {
      "type": "number"
    },
    "maxScore": {
      "type": "number"
    },
    "showTimer": {
      "type": "string",
      "enum": [
        "Yes",
        "No"
      ],
      "default": "No"
    },
    "showFeedback": {
      "type": "string",
      "enum": [
        "Yes",
        "No"
      ],
      "default": "No"
    },
    "showSolutions": {
      "type": "string",
      "enum": [
        "Yes",
        "No"
      ],
      "default": "No"
    },
    "interactionTypes":{
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "choice",
          "text",
          "select",
          "date",
          "file-upload",
          "canvas"
        ]
      }
    },
    "templateId":{
      "type": "string"
    },
    "bloomsLevel" : {
      "description": "Cognitive processes involved to answer the question set.",
      "type": "string",
      "enum": [
        "remember",
        "understand",
        "apply",
        "analyse",
        "evaluate",
        "create"
      ]
    },
    "feedback": {
      "type": "object"
    },
    "responseProcessing": {
      "type": "object"
    },
    "templateDeclaration": {
      "type": "object"
    },

    "dailySummaryReportEnabled": {
      "type": "string",
      "enum": [
        "Yes",
        "No"
      ]
    },
    "allowAnonymousAccess": {
      "type": "string",
      "enum": [
        "Yes",
        "No"
      ],
      "default": "Yes"
    },
    "termsAndConditions": {
      "type": "string"
    },
    "expectedDuration": {
      "type": "number"
    },
    "completionCriteria": {
      "type": "object"
    },
    "collaborators": {
      "type": "array"
    },
    "semanticVersion": {
      "type": "string"
    },
    "schemaVersion": {
      "type": "string"
    },
    "requestChanges": {
      "type": "string"
    },
    "variants": {
      "type": "object"
    },
    "rejectComment": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

config.json:

{
  "objectType": "Question",
  "relations": {
    "questionSet": {
      "type": "hasSequenceMember",
      "direction": "in",
      "objects": ["QuestionSet", "QuestionSetImage"]
    }
  },
  "restrictProps": {
    "create" : [
    ],
    "update" : [
      "visibility", "code", "status", "mimeType"
    ]
  },
  "version": "enable",
  "versionCheckMode": "ON",
  "frameworkCategories": ["board","medium","subject","gradeLevel","topic"],
  "orgFrameworkTerms": ["boardIds", "gradeLevelIds", "subjectIds", "mediumIds", "topicsIds"],
  "targetFrameworkTerms": ["targetFWIds", "targetBoardIds", "targetGradeLevelIds", "targetSubjectIds", "targetMediumIds", "targetTopicIds"],
  "cacheEnabled": false,
  "schema_restrict_api": true,
  "external": {
    "tableName": "question_data",
    "properties": {
      "body": {
        "type": "blob"
      },
      "editorState": {
        "type": "string"
      },
      "answer": {
        "type": "blob"
      },
      "solutions": {
        "type": "string"
      },
      "instructions": {
        "type": "string"
      },
      "hints": {
        "type": "string"
      },
      "media": {
        "type": "string"
      },
      "responseDeclaration": {
        "type": "string"
      },
      "interactions": {
        "type": "string"
      }
    },
    "primaryKey": ["identifier"]
  }
}
PreviousSchemaNextQuestionSet Schema

Last updated 3 years ago

Was this helpful?