Saba Performance APIs

• Goal

  • List Methods
  • Expand Methods

  • GETGet the details of a particular goal/performance/goals/:id?searchFields=:searchFields
    Returns complete information about a goal based on the goal assignment ID that is passed as a parameter value.
    
    

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

  • GETGet all goals for a person/performance/goals?q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage&includeDetails=:includeDetails
    Returns all goals for a given user. An admin invoking this REST API will see the goals of all the users. Non-admin persons (if-logged in) invoking this REST API will see their own goals. They can also view another person's goals by specifying the assignee's ID as the search criteria, provided they have the privilege to view that assignee's goals.
    
    

    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.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.
    includeDetails		string	query	If true then returns the complete details of Goal

  • POSTCreate Goal for self/team/performance/goals
    Creates a Goal for self/team
    
    

    Parameter	Value	Type	Location	Description
    @type		string	query	@type
    goalAssignmentDetail		string	query	Detail of a Goal Assignment
    goalDefinitionDetail		string	query	Detail of a Goal Definition
    assignees		string	query	Assignee of goals (Required only while creating team goal)
    isDirectIndirect		string	query	Whether it is direct or undirect goal
    tasks		string	query	Tasks to add
    parentGoal		string	query	Wrapper Reference of parent goal
    associationsData		string	query	Association Data
    submitForApproval		string	query	Whether to submit for approval or not

  • PUTUpdate Goal/performance/goals/:goalId
    Updates a Goal
    
    

    Parameter	Value	Type	Location	Description
    goalId		string	query	Id of goal
    @type		string	query	@type
    goalAssignmentDetail		string	query	Detail of a Goal Assignment
    goalDefinitionDetail		string	query	Detail of a Goal Defenition
    submitForApproval		string	query	Whether to submit for approval or not
    isPartialUpdate		string	query	Whether it is partial update or not

  • POSTCreate progress of a Goal/performance/goals/:goalId/createProgress
    Creates progress of a Goal
    
    

    Parameter	Value	Type	Location	Description
    goalId		string	query	Id of goal
    @type		string	query	@type
    goalStatus		string	query	Status of a Goal
    percentageCompleted		string	query	The total percentage completed
    currentValue		string	query	Current value
    comment		string	query	Comment

  • PUTChange status of a Goal/performance/goals/:goalId/changeStatus
    Changes the status of a Goal
    
    

    Parameter	Value	Type	Location	Description
    goalId		string	query	Id of goal
    @type		string	query	@type
    goalStatus		string	query	Status of a Goal
    comment		string	query	Comment
    overwritePercentage		string	query	Whether to overwrite percentage or not

  • PUTUpdate approver of goal./performance/goals/:goalId/approvers
    Updates the approver of a goal
    
    

    Parameter	Value	Type	Location	Description
    goalId		string	query	Id of goal
    @type		string	query	@type
    restApprover		string	query	Detail of a Goal Approver
    changeLog		string	query	Log of changes of attributes

• Competency

  • List Methods
  • Expand Methods

  • GETGet the details of a particular competency of a particular person/performance/competencies/:id:(:searchFields)?assignee=:assignee
    Returns complete information about a competency based on the competency ID and person ID that are passed as parameter values.
    
    

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

  • GETGet all the competencies for a person/performance/competencies?type=:type&q=(:criteria_field%3D%3D:field_value)&count=:count&startPage=:startPage
    Returns all the competencies for a given user. A user (if-logged in) invoking this REST API will see their own competencies. They can also view another person's competencies by specifying the assignee's ID as the search criteria, provided they have the privilege to view that assignee's competencies.
    
    

    Parameter	Value	Type	Location	Description
    type	heldrequiredall	enumerated	query	The type of competencies. It can be either held or required.If type is not specified then all competencies will be returned
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    criteria_field		string	query	The search criteria i.e. the field name.
    field_value		string	query	The search value for the specified search criteria.

  • GETGet all the Assessment of competencies for a person/performance/competencies/:competencyId/:assignee/assessments
    Returns all the assessments of competencies for a given user.
    
    

    Parameter	Value	Type	Location	Description
    competencyId		string	query	Competency ID
    assignee		string	query	assignee , person id

• Review Cycle

  • List Methods
  • Expand Methods

  • GETGet the meta details of a component/review-cycle/meta:(:searchFields)
    Returns the meta details of a review-detail component.
    
    

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

  • GETGet the details of a particular review cycle/review-cycle/:id:(:searchFields)
    Returns the details of a review-cycle.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	The id of the desired review cycle
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive)

  • GETGet the extended details of a particular review cycle/reviews/reviewCycle/:id?expand=:searchFields
    Returns extended details of a review-cycle.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	The id of the desired review cycle
    searchFields		string	query	Indicate what additional details needs to be returned. Acceptable values are (case-sensitive) reviewcycle,ratinglevels,requiredraters,orgratinglevels,reviewform

  • GETGet all review cycles/review-cycle?count=:count&startPage=:startPage
    Returns all review cycles.
    
    

    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 review cycles/review-cycle?q=(:criteria)&f=(:display)&count=:count&startPage=:startPage&includeDetails=:detailsFlag
    Find the details of the review cycles
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	Conditions
    display		string	query	Comma separated list of attributes to be displayed in output
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    detailsFlag		string	query	Flag to indicate if details needs to be returned.

• Review

  • List Methods
  • Expand Methods

  • GETGet the meta details of a component/review/meta:(:searchFields)
    Returns the meta details of a review component.
    
    

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

  • GETGet the details of a particular review/review/:id:(:searchFields)
    Returns the details of a review.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	The id of the desired review

  • GETGet the extended details of a particular review/reviews/:id
    Returns extended details of a review.
    
    

    Parameter	Value	Type	Location	Description
    id		string	query	The id of the desired review

  • GETFind all reviews/review?f=(:display)&count=:count&startPage=:startPage
    Find the details of the reviews
    
    

    Parameter	Value	Type	Location	Description
    display		string	query	Acceptable values are (case-sensitive) cycle_name,cycle_type,cycle_subtype,cycle_start_date,cycle_end_date,name,description,status,calculation_method,initiative_id,holder_name,period_start,period_end,collect_date,due_date,rating_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 reviews/review?q=(:criteria)&f=(:display)&count=:count&startPage=:startPage&includeDetails=:detailsFlag
    Find the details of the reviews
    
    

    Parameter	Value	Type	Location	Description
    criteria		string	query	Conditions
    display		string	query	Acceptable values are (case-sensitive) cycle_name,cycle_type,cycle_subtype,cycle_start_date,cycle_end_date,name,description,status,calculation_method,initiative_id,holder_name,period_start,period_end,collect_date,due_date,rating_description,holder_id,owner_id,has_ack,owner_name
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    detailsFlag		string	query	Flag to indicate if details needs to be returned.

  • POSTFind the details of the reviews with POST based search/review/searchQuery?f=(:display)&count=:count&startPage=:startPage&includeDetails=:detailsFlag
    Find the details of the reviews
    
    

    Parameter	Value	Type	Location	Description
    conditions		string	query	Conditions
    display		string	query	Acceptable values are (case-sensitive) cycle_name,cycle_type,cycle_subtype,cycle_start_date,cycle_end_date,name,description,status,calculation_method,initiative_id,holder_name,period_start,period_end,collect_date,due_date,rating_description,holder_id,owner_id,has_ack,owner_name
    count		string	query	The number of records per page.
    startPage		string	query	The start page number for the list of records.
    detailsFlag		string	query	Flag to indicate if details needs to be returned.

• Pulse

  • List Methods
  • Expand Methods

  • GETGet pulse dashboard detail/pulse/pulseDashboard?filter=:filter&value=:value&type=:type&date_from=:date_from&date_to=:date_to
    Returns complete information of pulse dashboard
    
    

    Parameter	Value	Type	Location	Description
    filter		string	query	filter criteria. Supported values are ORG,JOB,COUNTRY,LOC,manager
    value		string	query	Value as per filter criteria.
    type		string	query	This is required only when filter is ORG. Supported values are internal , external
    date_from		string	query	Date filter in form of yyyy-mm-dd
    date_to		string	query	Date filter in form of yyyy-mm-dd

  • GETGet Chart question data/pulse/chartQuestionData?filter=:filter&value=:value&type=:type&date_from=:date_from&date_to=:date_to&dimen=:dimen&configId=:configId
    Returns complete information of Chart question data
    
    

    Parameter	Value	Type	Location	Description
    filter		string	query	filter criteria. Supported values are ORG,JOB,COUNTRY,LOC,manager
    value		string	query	Value as per filter criteria.
    type		string	query	This is required only when filter is ORG. Supported values are internal , external
    date_from		string	query	Date filter in form of yyyy-mm-dd
    date_to		string	query	Date filter in form of yyyy-mm-dd
    dimen		string	query	Dimention. Supported values are PERN, MGMT, CMPY
    configId		string	query	Pulse Saba id

  • GETGet admin heatmap data/pulse/heatMapDashboard?filter=:filter&value=:value&type=:type&date_from=:date_from&date_to=:date_to&isOrgAdmin=:isOrgAdmin&sortOrder=:sortOrder&pageNumber=:pageNumber&pageSize=:pageSize
    Returns complete information of admin heatmap data
    
    

    Parameter	Value	Type	Location	Description
    filter		string	query	filter criteria. Supported values are ORG,JOB,COUNTRY,LOC,manager
    value		string	query	Value as per filter criteria.
    date_from		string	query	Date filter in form of yyyy-mm-dd
    date_to		string	query	Date filter in form of yyyy-mm-dd
    isOrgAdmin		string	query	Organization admin specific heatmap. Supported values are true, false
    sortOrder		string	query	Sorting order. Supported values are DESC, ASC
    pageNumber		string	query	Page number
    pageSize		string	query	Page size. Default value 10

  • GETGet active survey info/pulse/surveyInfo
    Returns survey along with question detail
    
    
  • POSTCreate pulse survey/pulse/survey
    Create pulse survey on behalf of user
    
    

    Parameter	Value	Type	Location	Description
    surveyResponse		string	query	Survey response detail