Saba Content APIs

• Content Inventory

  • List Methods
  • Expand Methods

  • GETGet the content's details along with the metadata/content/:id:(:searchFields)
    Obtains the details of a specific content. It also returns the content's metadata.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Content's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the content's details along with the subscriptions,tags,categories,languages,owners/contentInventory/search?q=(:criteria)&includeDetails=:includeDetails&count=:count&startPage=:startPage
    Obtains the details of a specific content. It also returns the sub details of content.
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	The search criteria i.e. the field name. (name or content_id and content_subscription,content_tags,content_categories,content_languages,content_owners)
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Include details

  • POSTGet the content's details along with the subscriptions,tags,categories,languages,owners (Using POST - Range based search)/contentInventory/search?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Obtains the details of a specific content. It also returns the sub details of content.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions that need to be used as part of the request body.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Include details

  • GETGet the content's metadata/content/meta:(:searchFields)
    It returns the content's metadata.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet All content inventory/content?count=:count&startPage=:startPage
    Returns all content inventory for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the content inventory/content?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the content inventory along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

• Content Folder

  • List Methods
  • Expand Methods

  • GETGet the details of a particular content folder, root folders, or a list of all the subfolders/contentfolder/:id:(:searchFields)
    Gets the details of a particular content folder. You can also obtain additional details like the root or sub folder's name, ID or the parent ID.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	Content's ID
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive): id,name,parent_id,subFolder,root. For example: 'root,id,name' would return IDs and names of the root along with IDs and names of the content folder. Similarly, 'root,id,parent_id,subFolder' would return IDs and Parent IDs of the root along with IDs and Parent IDs of the sub folders and the content folder.

  • GETGet the contentFolder's metadata/contentfolder/meta:(:searchFields)
    It returns the contentFolder's metadata.
    
    

    Parameter	Value	Type	Location	Description
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive): id,name,parent_id,subFolder,root. For example: 'root,id,name' would return IDs and names of the root along with IDs and names of the content folder. Similarly, 'root,id,parent_id,subFolder' would return IDs and Parent IDs of the root along with IDs and Parent IDs of the sub folders and the content folder.

  • GETGet All content folder/contentfolder?count=:count&startPage=:startPage
    Returns all content folder for which the user has access.
    
    

    Parameter	Value	Type	Location	Description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of the content folder/contentfolder?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns the details of the content folder along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate a new content folder/contentfolder/
    Creates a new content folder.
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name of the content folder
    securityDomain		string	query	Security Domain for the content folder
    auditReason		string	query	The audit reason
    parent_id		string	query	The Parent ID of the content folder

• Core Services

  • List Methods
  • Expand Methods

  • GETGet version details of the product/coreservice/version/
    Gets the major, minor, and complete version numbers of the product.
    
    
  • GETGet a list of sites/coreservice/sites/
    Gets a list of available sites in the system.
    
    
  • GETGet a CIF certificate/coreservice/certificate/
    Obtains a CIF certificate for a specific site based on the username and password passed as parameter values.
    
    

    Parameter	Value	Type	Location	Description
    userName		string	header	The username
    password		string	header	The user password
    siteName		string	header	The site name
    timeOutInMilliSeconds		string	header	The time out in milliseconds

  • GETGet the initial system values for contentTypes, contentFormats, contentServers/coreservice/initial-values/
    Returns the initial system values for contentTypes, contentFormats, contentServers for a particular site based the CIF certificate passed as a parameter value.
    
    

    Parameter	Value	Type	Location	Description
    certificate		string	header	The CIF certificate

• Report Content Result

  • List Methods
  • Expand Methods

  • POSTReport result/partner/reportResult
    To report content result back to Saba.
    
    

    Parameter	Value	Type	Location	Description
    trackingKey		string	query	This will be sent by Saba during content launch/entitlement(250 characters key limit).
    registrationID		string	query	This will be sent by Saba during content launch/entitlement. This should be used in combination with externalContentID and vendorName. Supported Content Format : URL
    employeeID		string	query	This will be sent by Saba during content launch/entitlement. This should be used in combination with externalContentID and vendorName. Supported Content Format : URL
    username		string	query	This will be sent by Saba during content launch/entitlement. This should be used in combination with externalContentID and vendorName. Supported Content Format : URL
    externalContentID		string	query	This will be sent by Saba during content launch/entitlement.
    vendorName		string	query	This will be sent by Saba during content launch/entitlement.
    completionStatus		string	query	Possible values could be - incomplete, completed, passed , failed. (Note: For URL type of content supported values are completed or passed)
    score		string	query	Optional if Completion Status is Incomplete/Completed. Mandatory if completion status is passed/failed.
    minScore		string	query	minScore
    maxScore		string	query	maxScore
    timeSpent		string	query	Time spent on the content, Please specify value in the following format hh:mm:ss example: 00:10:00

  • POSTCancel Registration/partner/cancelRegistration?trackingKey=:trackingKey
    Cancel Registration
    
    

    Parameter	Value	Type	Location	Description
    trackingKey		string	query	This will be sent by Saba during content launch/entitlement(250 characters key limit).

• Assessment

  • List Methods
  • Expand Methods

  • GETGet all Assessments/assessment?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the All Assessments
    
    

    Parameter	Value	Type	Location	Description
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet all Assessments with criteria/assessment/folder?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The criteria value i.e. the field value.
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind all Assessments searchQuery with criteria/assessment/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessments based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet Detail of Assessment/assessment/:examid?type=test
    Returns the details of the Assessment
    
    

    Parameter	Value	Type	Location	Description
    examid		string	query	ExamID

  • GETGet all Assessment folders/assessment/folder?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the All Assessment folders
    
    

    Parameter	Value	Type	Location	Description
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of Assessment folders/assessment/folder?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment folders based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The criteria value i.e. the field value.
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Assessment folders with criteria/assessment/folder/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment folders based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet all Assessment Question folders/assessment/question-folder?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the All Assessment question folders
    
    

    Parameter	Value	Type	Location	Description
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of Assessment Question folders/assessment/question-folder?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment question folders based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The criteria value i.e. the field value.
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Assessment Question folders with criteria/assessment/question-folder/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment Question folders based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETGet all Assessment Questions/assessment/question?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the All Assessment questions
    
    

    Parameter	Value	Type	Location	Description
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • GETFind the details of Assessment Questions/assessment/question?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment question based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The criteria value i.e. the field value.
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTFind the details of Assessment Questions with criteria/assessment/question/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns the details of the Assessment Questions based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    includeDetails		string	query	Flag to include details.
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.

  • POSTCreate Assessment/assessment?type=:type
    Create Assessment
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name
    advancedAssessmentServiceFlag		string	query	Advanced Assessment Service Flag
    type		string	query	Type
    exitBeforeFinish		string	query	Exit Before Finish
    showCorrectAnswer		string	query	Show Correct Answer
    showFeedback		string	query	Show Feedback
    allowReviewOfQuestionType		string	query	Allow Review Of Question Type
    playmodeTemplateId		string	query	Playmode Template Id
    settingsMode		integer	query	Settings Mode
    templateId		string	query	Template Id
    timeLimitAllowed		string	query	Time Limit Allowed
    strictTimeLimit		string	query	Strict Time Limit
    showQuestionList		string	query	Show Question List
    webAccessibility		string	query	Web Accessibility
    minPassingScoreForPlaymode		integer	query	Min Passing Score For Playmode
    standaloneLaunchURL		string	query	Standalone Launch URL
    waterMarkSupport		string	query	Watermark Support
    disableCopyPaste		string	query	Disable Copy Paste
    remoteProctoringServiceFlag		string	query	Remote Proctoring Service Flag
    compatibilityMode		string	query	Compatibility Mode
    customTemplateId		string	query	Custom Template Id
    name		string	query	Name
    author		string	query	Author
    ownerId		string	query	Owner Id
    aclEnabled		string	query	ACL Enabled
    coAuthors		array	query	CoAuthors
    resolvedOwnerInformation		string	query	Resolved Owner Information
    extExamId		string	query	External Exam Id
    rootExamId		string	query	Root Exam Id
    active		boolean	query	Active
    status		string	query	Status
    deliveryLang		string	query	Delivery Language
    introductoryMessage		string	query	Introductory Message
    conclusionMessage		string	query	Conclusion Message
    successMessage		string	query	Success Message
    failureMessage		string	query	Failure Message
    locked		string	query	Locked
    lockedBy		string	query	Locked By
    lockedOn		integer	query	Locked On
    snapshotId		integer	query	Snapshot Id
    highStakes		string	query	High Stakes
    passingCriteriaAllowed		string	query	Passing Criteria Allowed
    reviewAllowed		string	query	Review Allowed
    feedbackAllowed		string	query	Feedback Allowed
    allowQuestionComments		string	query	Allow Question Comments
    reviewTopicsAllowed		string	query	Review Topics Allowed
    reviewAnswersAllowed		string	query	Review Answers Allowed
    multipleQuestionsPerPage		string	query	Multiple Questions Per Page
    questionsPerPage		integer	query	Questions Per Page
    hideAnswersInReview		string	query	Hide Answers in Review
    showStructureHeader		string	query	Show Structure Header
    launchLimitForViewAnswer		integer	query	Launch Limit For View Answer
    minoredit		string	query	Minor Edit
    adaptive		string	query	Adaptive
    contentFolderName		string	query	Content Folder Name
    contentFolderId		string	query	Content Folder Id
    offeringId		string	query	Offering Id
    learningAssignmentType		integer	query	Learning Assignment Type
    proctoringRequired		string	query	Proctoring Required
    examProctor		array	query	Exam Proctor
    proctorMode		string	query	Proctor Mode
    showScorecard		string	query	Show Scorecard
    split		string	query	Split
    domainName		string	query	Domain Name
    showTestTopicScorecard		string	query	Show Test Topic Scorecard
    langEnabled		string	query	Language Enabled
    langList		array	query	Language List
    languageId		string	query	Language Id
    hasAssessor		string	query	Has Assessor
    roleBasedAssessor		string	query	Role Based Assessor
    examAssessor		array	query	Exam Assessor
    overrideQuestionsStyling		string	query	Override Questions Styling
    overrideMessagesStyling		string	query	Override Messages Styling
    showUnansweredQues		string	query	Show Unanswered Questions
    description		string	query	Description
    topics		array	query	Topics
    questions		array	query	Questions
    hintAllowed		string	query	Hint Allowed
    timeoutWarning		integer	query	Timeout Warning
    timeLimitOn		string	query	Time Limit On
    timeLimitInSeconds		integer	query	Time Limit In Seconds
    partialCreditAllowed		string	query	Partial Credit Allowed
    previousAllowed		string	query	Previous Allowed
    allowNavigation		string	query	Allow Navigation
    mustPass		string	query	Must Pass
    minimumPassScore		integer	query	Minimum Pass Score
    scrambleChoices		string	query	Scramble Choices
    showScoreInReview		string	query	Show Score In Review
    showStatusInReview		string	query	Show Status In Review
    questionOrder		integer	query	Question Order
    randomization		string	query	Randomization
    subordinateOrder		integer	query	Subordinate Order
    subsetSize		integer	query	Subset Size
    totalQuestions		integer	query	Total Questions Count
    formatedUpdatedOn		string	query	Formatted Updated On
    formatedCreatedOn		string	query	Formatted Created On

  • POSTAdd Question to assessment/learning/assessment?type=:type
    Add Question to assessment
    
    

    Parameter	Value	Type	Location	Description
    examid		string	query	ExamID
    body		string	query	ExamID

  • POSTCreate a new version of published assessment/assessment/:examid/version
    Create a new version of published assessment
    
    

    Parameter	Value	Type	Location	Description
    examid		string	query	ExamID

  • PUTEdit Assessment/assessment/:examid
    Edit an assessment in darft state
    
    

    Parameter	Value	Type	Location	Description
    examid		string	query	Assessment Id
    name		string	query	Title of the Assessment
    description		string	query	Description of the Assessment
    extExamId		string	query	Exam ID
    status		string	query	Status of the Assessment. It can be set to published
    split		string	query	Domain Id
    aclEnabled		string	query	Security is domain based or not
    coAuthors		string	query	If aclEnabled is true then pass list of users. e.g [ "emplo000000000200093" ]
    langEnabled		string	query	Add language support?
    langList		string	query	If langEnabled is true then pass list of languages.e.g [{ "displayName": "English", "id": "lange000000000000001" }, { "displayName": "Hindi", "id": "lange000000000000028" }]
    adaptive		string	query	Enable topic branching
    customTemplateId		string	query	Choose Theme(Custom template id)
    overrideQuestionsStyling		string	query	Override question style
    overrideMessagesStyling		string	query	Override messages style
    introductoryMessage		string	query	Introductory message
    conclusionMessage		string	query	Concluding message
    successMessage		string	query	At or Above passing score message
    failureMessage		string	query	Below passing score message
    settingsMode		string	query	How to set the properties? Individual properties:0, Use property template: 1
    templateId		string	query	Property template id. e.g: pmtmp000000000001141 (If settingsMode is 1 then give this id)
    timeLimitOn		string	query	Time Limit for: NONE, EXAM, QUESTION
    strictTimeLimit		string	query	Strict time limit(Can be set to true only when timeLimitOn is EXAM)
    timeLimitInSeconds		string	query	Time Allowed in sec (Can be set only when timeLimitOn is EXAM or QUESTION)
    timeoutWarning		string	query	Timeout warning in minutes (Can be set only when timeLimitOn is EXAM)
    randomization		string	query	Question order. Possible values:RANDOM, IN_ORDER, TOPIC_ORDER
    partialCreditAllowed		string	query	Partial credit
    scrambleChoices		string	query	Scramble choices
    showQuestionList		string	query	Show Question List
    allowNavigation		string	query	Allow navigation
    showUnansweredQues		string	query	Show unanswered questions
    subsetSize		string	query	Subset. If set as 0 then subset is disabled
    allowQuestionComments		string	query	Allow question comment
    hintAllowed		string	query	Show hint
    passingCriteriaAllowed		string	query	Passing enabled
    minimumPassScore		string	query	Passing score(Can be set only when passingCriteriaAllowed is true)
    reviewAllowed		string	query	Allow review. Possible values: ALWAYS,NEVER,ON_PASS
    hideAnswersInReview		string	query	Hide answers in review(Can be set only when reviewAllowed is ALWAYS or ON_PASS)
    launchLimitForViewAnswer		string	query	Launch limit for view answer(Can be set only when reviewAllowed is ALWAYS or ON_PASS)
    feedbackAllowed		string	query	Allow immediate feedback(Can be set only when reviewAllowed is ALWAYS or NEVER)
    showScorecard		string	query	Show scorecard
    showTestTopicScorecard		string	query	Break down by topic
    multipleQuestionsPerPage		string	query	Multiple questions per page
    questionsPerPage		string	query	Questions per page(can be set when multipleQuestionsPerPage is true)
    showStructureHeader		string	query	Show topic headers
    deliveryLang		string	query	Delivery language. Possible values: USER_LOCALE, CLASS, USER_SELECTED
    compatibilityMode		string	query	Compatibility mode. provide the device name fom list of vals
    highStakes		string	query	High stake test
    proctoringRequired		string	query	Proctor required
    proctorMode		string	query	Proctoring mode. Possible value INPERSON (can be set when proctoringRequired is true)
    examProctor		string	query	Proctor user list(can be set when proctoringRequired is true) e.g: [{"proctorName": "Alla Engel", "proctorId": "emplo000000000200101" }]
    hasAssessor		string	query	Assessor required
    roleBasedAssessor		string	query	Role based assessor (can be set when hasAssessor is true)
    examAssessor		string	query	Assessor user list(can be set when hasAssessor is true) e.g: [{"assessorName": "Alla Engel", "assessorId": "emplo000000000200101" }]

  • PUTMinor edit Assessment/assessment/:examid
    minor edits for an assessment in published state
    
    

    Parameter	Value	Type	Location	Description
    examid		string	query	Assessment Id
    name		string	query	Title of the Assessment
    description		string	query	Description of the Assessment
    introductoryMessage		string	query	Introductory message
    conclusionMessage		string	query	Concluding message
    successMessage		string	query	At or Above passing score message
    successMessage		string	query	At or Above passing score message
    failureMessage		string	query	Below passing score message
    proctoringRequired		string	query	Proctor required
    proctorMode		string	query	Proctoring mode. Possible value INPERSON (can be set when proctoringRequired is true)
    examProctor		string	query	Proctor user list(can be set when proctoringRequired is true) e.g: [{"proctorName": "Alla Engel", "proctorId": "emplo000000000200101" }]
    hasAssessor		string	query	Assessor required
    roleBasedAssessor		string	query	Role based assessor (can be set when hasAssessor is true)
    examAssessor		string	query	Assessor user list(can be set when hasAssessor is true) e.g: [{"assessorName": "Alla Engel", "assessorId": "emplo000000000200101" }]

  • POSTCreate question pool folder/assessment/question-folder
    create a question pool folder
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Folder name
    domain		string	query	Domain
    assessmentType		string	query	Type of the assessment. Possible values: Test
    parent		string	query	Parent folder id. If its a root level folder we can keep this as null or blank else provide the parent folder id e.g: asfld000000000001120
    aclEnabled		string	query	Security enabled
    acl		string	query	Provide the acl list with users and roles (can be set when aclEnabled is true)

  • PUTUpdate question pool folder/assessment/question-folder/:folderId
    update a question pool folder
    
    

    Parameter	Value	Type	Location	Description
    folderId		string	query	Question folder Id
    name		string	query	Folder name
    domain		string	query	Domain
    assessmentType		string	query	Type of the assessment. Possible values: Test
    parent		string	query	Parent folder id. If its a root level folder we can keep this as null or blank else provide the parent folder id e.g: asfld000000000001120
    aclEnabled		string	query	Security enabled
    acl		string	query	Provide the acl list with users and roles (can be set when aclEnabled is true)

  • DELETEDelete question pool folder/assessment/question-folder/:folderId
    delete a question pool folder
    
    

    Parameter	Value	Type	Location	Description
    folderId		string	query	Folder Id

  • POSTCreate question (FILL_IN_THE_BLANKS)/assessment/question
    create a FILL_IN_THE_BLANKS question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: choice text choiceGroup: choice group for each __. e.g: choiceGroup:1 for first __, choiceGroup:2 for second __ and so on.
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID

  • POSTCreate question (YES_NO)/assessment/question
    create a YES_NO question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: The answer text (should be translated for other languages for question types YES_NO and TRUE_FALSE) correctAnswer: Boolean (true for the correct choice; only one should be marked as correct)
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID

  • POSTCreate question (MULTIPLE_CHOICE)/assessment/question
    create a MULTIPLE_CHOICE question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: choice text value: points per choice. should be integer value choiceFeedback: feedback per choice
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID
    lockLastChoice		string	query	Indicates whether to lock last choice
    pointsPerChoice		string	query	Indicates whether points per choice should be considered or not
    quesScrambleChoices		string	query	Indicates whether to scramble the choices

  • POSTCreate question (TRUE_FALSE)/assessment/question
    create a TRUE_FALSE question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: The answer text (should be translated for other languages for question types YES_NO and TRUE_FALSE) correctAnswer: Boolean (true for the correct choice; only one should be marked as correct)
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID

  • POSTCreate question (ALL_THAT_APPLY)/assessment/question
    create a ALL_THAT_APPLY question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: choice text correctAnswer: Boolean (true for the correct choice; multiple answer choices can be marked as correct here)
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID
    quesScrambleChoices		string	query	Indicates whether to scramble the choices

  • POSTCreate question (NUMERIC_FILL_IN_THE_BLANKS)/assessment/question
    create a NUMERIC_FILL_IN_THE_BLANKS question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: exact answer can be mentioned here as ""body"": 8. Minimum and maximum answer can be mentioned as ""body"": ""14:15"" choiceGroup: choice group for each __. e.g: choiceGroup:1 for first __, choiceGroup:2 for second __ and so on.
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID

  • POSTCreate question (MATCH)/assessment/question
    create a MATCH question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: choice text choiceGroup: Identifies the group the choice belongs to. For example, choiceGroup: 1 is used for the main choices section, and choiceGroup: 2 is used for the matching section. ordinal: A numerical value representing the order of the choice. The first choice and its corresponding match use ordinal: 1, the second pair use ordinal: 2, and so on. Correct Answer Mapping: To indicate the correct matches between the main choices (choiceGroup: 1) and the corresponding match choices (choiceGroup: 2), you must include a special entry with: { ""body"": ""3-3,2-2,1-1"", ""choiceGroup"": 3, ""correctAnswer"": true } body: A comma-separated string showing the correct matchings. Each match is expressed as mainOrdinal-matchOrdinal. For e.g. ""3-3"" means the choice with ordinal: 3 in choiceGroup: 1 is matched to the option with ordinal: 3 in choiceGroup: 2. choiceGroup: Always set to 3 for this object, indicating it’s a mapping definition, not a user-facing choice. correctAnswer: Set to true to identify this entry as the correct answer.
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID

  • POSTCreate question (PULLDOWN)/assessment/question
    create a PULLDOWN question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Each choice includes: body: choice text choiceGroup: Identifies the group the choice belongs to. correctAnswer: Set to true to identify this entry as the correct answer.
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID
    quesScrambleChoices		string	query	Indicates whether to scramble the choices

  • POSTCreate question (CONTENT)/assessment/question
    create a CONTENT question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.Here we simply pass ""choiceGroup"": 1 as this is content type question
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID

  • POSTCreate question (ESSAY)/assessment/question
    create a ESSAY question
    
    

    Parameter	Value	Type	Location	Description
    language		string	query	Language
    externalId		string	query	External question ID
    questTagDetail		string	query	Tags list
    mandatory		string	query	Indicates whether the question is mandatory
    body		string	query	Question text
    type		string	query	Type of the question
    choices		string	query	List of choices for the question.body: default text choiceGroup: Identifies the group the choice belongs to.
    parent		string	query	parent folder ID of the question
    feedback		string	query	General feedback for the question
    status		string	query	Status of the question (DRAFT or PUBLISHED)
    allowComment		string	query	Indicates whether learner comments are allowed
    customCommentLabel		string	query	Custom label for the comment section
    difficulty		string	query	Difficulty level of the question (EASY, MEDIUM, DIFFICULT)
    feedbackCorrect		string	query	Feedback shown when the correct answer is selected
    feedbackWrong		string	query	Feedback shown when an incorrect answer is selected
    hint		string	query	Hint to help the learner answer the question
    notes		string	query	Additional notes or internal comments
    duration		string	query	Duration in minutes for answering the question
    weight		string	query	Weight of the question.
    intent		string	query	Whether the question is for a TEST or SURVEY
    linkedContentQstId		string	query	Linked content question ID
    answerLimit		string	query	no of characters. The answer limit must be a positive integer between 1 and 5000