Saba Social APIs

• Social Resource

  • List Methods
  • Expand Methods

  • POSTPost resource to saba activity stream./social/resource
    Posts resoruce to the saba activity stream.
    
    

    Parameter	Value	Type	Location	Description
    resourceType		string	query	Resource Type
    name		string	query	resource title
    url		string	query	URL of Link resource. (Only in case Link resource type)
    owner		string	query	Owner of the resource.
    description		string	query	Description of the resource.
    disableSharing		Boolean	query	Disable users to share this resource.
    shareWith		string	query	List of entity with whom is to be shared. It could be person and/or group.
    language		string	query	Language of the resource.
    notifyingEntity	PeopleGroupPersonAndGroup	enumerated	query	Whom to notify, it's value could be person, group or peopleandgroup.
    tag		string	query	Tags on the resource.

  • PUTUpdate resource posted on Saba activity stream./social/resource/:resourceId
    Update resource posted on the saba activity stream.
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	resource Id
    name		string	query	Resource title
    owner		string	query	Owner of the resource.
    description		string	query	Description of the resource.
    implementationLead		string	query	Implementation Leader of the resource.
    state	NewOpenOnHoldClosed	enumerated	query	State of resource.
    status	1101102103104105201301302303	enumerated	query	Status of resource . Though its validity depends on the status selected for the resource .
    disableSharing		Boolean	query	Disable users to share this resource.
    notifyingEntity	PeopleGroupPersonAndGroup	enumerated	query	Whom to notify, it's value could be person, group or peopleandgroup.
    language		string	query	Language of the resource.

  • PUTUpdate Link posted on saba activity stream./social/resource/:resourceId
    Update link posted on the saba activity stream.
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Link resource Id
    name		string	query	Link title
    url		string	query	URL of the link .
    owner		string	query	Owner of the link .
    description		string	query	Description of the Link.
    disableSharing		Boolean	query	Disable users to share this link.
    notifyingEntity	PeopleGroupPersonAndGroup	enumerated	query	Whom to notify, it's value could be person, group or peopleandgroup.
    language		string	query	Language of the link.
    tag		string	query	Tags on the link.

  • DeleteDelete resource posted on Saba activity stream./social/resource/:resourceId
    Delete resource posted on the saba activity stream.
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	resource Id

  • GETGet user social metrics/social/metrics/:personId?resource=:resources&from_date=:from_date&to_date=:to_date
    Get users social interaction metrics.
    
    

    Parameter	Value	Type	Location	Description
    personId		string	query	Person Id
    resources		string	query	List of resources.
    from_date		string	query	From date
    to_date		string	query	To date

  • GETFind social resources/social/resource?type=:resourceType&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Find social resources
    
    

    Parameter	Value	Type	Location	Description
    resourceType		string	query	Social resource type
    count		string	query	Number of record per page
    startPage		string	query	Starting page
    includeDetails		string	query	Include details or not.

  • GETGet social resource detail/social/resource/:resourceId
    Get social resource detail
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Social resource Id

  • POSTFind social resorces (Using POST - Range based search)/social/resource/searchQuery?type=:type&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Searches for social resoures along with the ID, Name and the Deeplink URL based on the provided search criteria.
    
    

    Parameter	Value	Type	Location	Description
    type		string	query	Resource Type
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Include detail of ssocial resources found.

  • GETGet like details of a resource/social/resource/:resourceId/likes?summary=:summary
    Get like details of a resource
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Resource Id
    summary		string	query	Show only summary

  • POSTLike or dislike a resource/social/resource/:resourceId/likes?thumbsDown=:thumbsDown
    Like or dislike a resource
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Resource Id
    thumbsDown		string	query	Like or dislike a resource

  • DELETELike or dislike a resource/social/resource/:resourceId/likes
    Like or dislike a resource
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Resource Id

  • GETGet comment details of a resource/social/resource/:resourceId/comment
    Get comment details of a resource
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Resource Id

  • GETFind social resource of a Group/social/resource/group/:groupId?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Find social resource of a Group
    
    

    Parameter	Value	Type	Location	Description
    groupId		string	query	Group Id, For User friendly give - 'groupName=myGroup1'.
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Include detail of ssocial resources found.

  • POSTFind social resorces of a Group (Using POST - Range based search)/social/resource/group/:groupId/searchQuery?count=:count&startPage=:startPage&includeDetails=:includeDetails
    Find social resorces of a Group - POST Based
    
    

    Parameter	Value	Type	Location	Description
    groupId		string	query	groupId
    conditions		string	query	Conditions
    count		string	query	No description
    startPage		string	query	No description
    includeDetails		string	query	Include detail of ssocial resources found.

  • POSTPost a comment on a resource/social/resource/:resourceId/comment
    Post a comment on a resource
    
    

    Parameter	Value	Type	Location	Description
    resourceId		string	query	Resource id.
    comment		string	query	Comment text.

  • POSTStart a new discussion/social/discussion/:groupId
    Start a new discussion
    
    

    Parameter	Value	Type	Location	Description
    groupId		string	query	Group id.
    subject		string	query	Discussion subject
    description		string	query	description text
    discussionCategory		string	query	Discussion forum category
    notifyGroup		string	query	Notify group members

  • GETGet discussion detail/social/discussion/:discussionId
    Get discussion detail
    
    

    Parameter	Value	Type	Location	Description
    discussionId		string	query	discussion id.

  • PUTUpdate discussion detail/social/discussion/:discussionId
    Update discussion detail
    
    

    Parameter	Value	Type	Location	Description
    discussionId		string	query	discussion id.
    subject		string	query	Discussion subject
    description		string	query	description text
    discussionCategory		string	query	Discussion forum category

  • DELETEDelete a discussion/social/discussion/:discussionId?reason:reason
    Delete a discussion
    
    

    Parameter	Value	Type	Location	Description
    discussionId		string	query	discussion id.
    reason		string	query	Reason

• Groups

  • List Methods
  • Expand Methods

  • GETGet group details/groups/:groupId?expand=:details
    Get group details for specific id.
    
    

    Parameter	Value	Type	Location	Description
    groupId		string	query	Group id
    details		string	query	Comma separated list of detail attributes

  • GETSearch My Groups/groups?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Search within my groups.
    
    

    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.
    includeDetails		string	query	Returns the details of the groups in the search

  • GETSearch Groups in Admin mode/groups?isAdmin=true&q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Search groups in collabration admin mode.
    
    

    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.
    includeDetails		string	query	Returns the details of the groups in the search

  • POSTSearch Groups (POST based)/groups?isAdmin=:isAdmin&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Search groups in collabration admin mode.
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    isAdmin		string	query	No description
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    includeDetails		string	query	Returns the details of the groups in the search

  • POSTManage group membership/groups/membership?action=(:action)
    Manage group membership with various operations like Join, Leave etc.
    
    

    Parameter	Value	Type	Location	Description
    action		string	query	Action like join, leave etc.
    @type		string	query	Input JSON class name
    team		string	query	Team
    personList		string	query	Person