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 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/learning/assessment?type=:type
    Create Assessment
    
    

    Parameter	Value	Type	Location	Description
    name		string	query	Name
    advancedAssessmentServiceFlag		boolean	query	Advanced Assessment Service Flag
    type		string	query	Type
    exitBeforeFinish		boolean	query	Exit Before Finish
    showCorrectAnswer		boolean	query	Show Correct Answer
    showFeedback		boolean	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		boolean	query	Time Limit Allowed
    strictTimeLimit		boolean	query	Strict Time Limit
    showQuestionList		boolean	query	Show Question List
    webAccessibility		boolean	query	Web Accessibility
    minPassingScoreForPlaymode		integer	query	Min Passing Score For Playmode
    standaloneLaunchURL		string	query	Standalone Launch URL
    waterMarkSupport		boolean	query	Watermark Support
    disableCopyPaste		boolean	query	Disable Copy Paste
    remoteProctoringServiceFlag		boolean	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		boolean	query	ACL Enabled
    coAuthors		array	query	CoAuthors
    resolvedOwnerInformation		object	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		boolean	query	Locked
    lockedBy		string	query	Locked By
    lockedOn		integer	query	Locked On
    snapshotId		integer	query	Snapshot Id
    highStakes		boolean	query	High Stakes
    passingCriteriaAllowed		boolean	query	Passing Criteria Allowed
    reviewAllowed		string	query	Review Allowed
    feedbackAllowed		boolean	query	Feedback Allowed
    allowQuestionComments		boolean	query	Allow Question Comments
    reviewTopicsAllowed		boolean	query	Review Topics Allowed
    reviewAnswersAllowed		boolean	query	Review Answers Allowed
    multipleQuestionsPerPage		boolean	query	Multiple Questions Per Page
    questionsPerPage		integer	query	Questions Per Page
    hideAnswersInReview		boolean	query	Hide Answers in Review
    showStructureHeader		boolean	query	Show Structure Header
    launchLimitForViewAnswer		integer	query	Launch Limit For View Answer
    minoredit		boolean	query	Minor Edit
    adaptive		boolean	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		boolean	query	Proctoring Required
    examProctor		array	query	Exam Proctor
    proctorMode		string	query	Proctor Mode
    showScorecard		boolean	query	Show Scorecard
    split		string	query	Split
    domainName		string	query	Domain Name
    showTestTopicScorecard		boolean	query	Show Test Topic Scorecard
    langEnabled		boolean	query	Language Enabled
    langList		array	query	Language List
    languageId		string	query	Language Id
    hasAssessor		boolean	query	Has Assessor
    roleBasedAssessor		boolean	query	Role Based Assessor
    examAssessor		array	query	Exam Assessor
    overrideQuestionsStyling		boolean	query	Override Questions Styling
    overrideMessagesStyling		boolean	query	Override Messages Styling
    showUnansweredQues		boolean	query	Show Unanswered Questions
    description		string	query	Description
    topics		array	query	Topics
    questions		array	query	Questions
    hintAllowed		boolean	query	Hint Allowed
    timeoutWarning		integer	query	Timeout Warning
    timeLimitOn		string	query	Time Limit On
    timeLimitInSeconds		integer	query	Time Limit In Seconds
    partialCreditAllowed		boolean	query	Partial Credit Allowed
    previousAllowed		boolean	query	Previous Allowed
    allowNavigation		boolean	query	Allow Navigation
    mustPass		boolean	query	Must Pass
    minimumPassScore		integer	query	Minimum Pass Score
    scrambleChoices		boolean	query	Scramble Choices
    showScoreInReview		boolean	query	Show Score In Review
    showStatusInReview		boolean	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