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).