SAP Knowledge Base Article - Public

2769812 - How to query GoalPlanTemplate - SuccessFactors OData

Symptom

This documentation aims to provide information on how to query GoalPlanTemplate information via OData API

Environment

 SuccessFactors BizX - all versions.

Resolution

The operation allowed for retrieving information from this entity is GET.

Properties:

id: ID of the goal template;

name: Name of the goal template;

description: description of the goal;

parentPlanId: ID of the parent goal plan;

displayOrder: Display order of the goal template;

startDate: Goal start date;

dueDate: Goal due date.

Use Cases:

API Call Description
/odata/v2/GoalPlanTemplate Query all goal plan templates
/odata/v2/GoalPlanTemplate?$expand=goals Query all goal plan templates and expand associated goals
/odata/v2/getDefaultGoalPlanTemplateId Query default goal plan template Id
/odata/v2/GoalPlanTemplate?$format=json&$expand=enums Get the lookup (including category name and id) and translations per template
/odata/v2/GoalPlanTemplate(111L)?$format=json&$expand=enums Query to filter the enums by goal plan template id. Here, for example Goal template ID is 111.

See Also

Find more information on SAP SuccessFactors HCM Suite OData API: Reference Guide

Keywords

OData; Goal Plan query; get goal information; GoalPlanTemplate; , KBA , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , LOD-SF-INT-ODATA , OData API Framework , How To

Product

SAP SuccessFactors HCM Suite all versions