Performance Management APIs Guide PDF

10/19/2022
SAP SuccessFactors HXM Suite OData

API: Reference Guide (V2)
Generated on: 2022-10-19 13:37:09 GMT+0000
SAP SuccessFactors Platform | 1H 2022
PUBLIC
Original content: https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/28bc3c8e3f214ab487ec51b1b8709adc?

locale=en-US&state=PRODUCTION&version=2205
Warning
This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
Portal, and may be missing important aspects and/or correlations to other topics. For this reason, it is not for productive use.
For more information, please visit the https://help.sap.com/docs/disclaimer.
This is custom documentation. For more information, please visit the SAP Help Portal 1
10/19/2022
Performance Management Form Entities

Form APIs provide the ability to query and update forms that are created for Performance Management or 360 Reviews.
Context
Form OData APIs enable you to:
Query a list of form templates.
Query a list of user form folders.
Query form details, including the User Info section, Objective section, Competency section, Summary section, and
Signature section in the form.
Normal users can only access the forms in their folders. The users, who have form OData Admin permission, can access all the
forms, even the ones that aren't in their folders. However, update operation is currently not supported.
You can also check a user's target population and make sure they can only access the forms, whose owners are in their target
population.
Permissions
If you have the following form OData admin permissions, you will be allowed to query the form data, but you will not be able to
edit, add, or delete form data. You can only access the folders and forms, whose owner is in your target population.
Permission System Required Settings Note
Role-Based Permissions Manage Documents Admin Access to Admin Access to Forms OData API allows
Forms OData API you to query forms of all users, but this
might be restricted by the speci c form
If you want to fetch the deleted forms,
template permissions.
select Include Deleted forms in Forms
ODATA API.
 Note
This permission works for the
FormHeader API only. If you have the
parent permission, Admin Access to
Forms OData API, but don't have the
Include Deleted forms in Forms ODATA
API permission, you can use the
FormHeader API to query active forms
only. For other APIs, with the parent
permission, you can query both active
and deleted forms.
FormHeader
You can use this entity to get the meta information of a speci c form or a list of forms, for example, form data ID, start date, end
date, and due date.
Permissions
10/19/2022
For more information on permissions, see Performance Management Form Entities.
Supported Operations
Operation Description
Query Query the meta information of a speci c form or a list of forms. FormHeader, that is formDataId, is
required for the query operation.
Properties and Navigation Properties
Property Description
formDataStatus The status of form data. The eld takes one of the following values:
1: The form is in the modify stage.
2: The form is in the rejected state.
3: The form is in the completed stage.
4: The form is deleted by the user or admins.
 Note
To fetch the deleted forms, go to Admin
Center Manage Permission
Roles <Permission> Administrator Permissions and
select Include Deleted forms in Forms ODATA API
under Manage Documents.
5: The form is in the signature stage.
This section lists only the properties and navigation properties that require special business logic, permission, or other
additional information. For more information, refer to the API dictionary in Admin Center API Center OData API Data
Dictionary or the API metadata using query: https://<api-server>/odata/v2/<Entity>/$metadata.
Use Case: Query the Meta Information of a Form

The following example shows how to query the meta information of a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-server>/odata/v2/FormHeader(272L)?
$format=json
Response
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormHeader(272L)",
10/19/2022
"type": "SFOData.FormHeader"
},
"formDataId": "272",
"formDataStatus": "1",
"formReviewDueDate": "/Date(1468886399000+0000)/",
"formTemplateId": "849",
"formTemplateType": "Review",
"formReviewStartDate": "/Date(1420070400000+0000)/",
"formOriginator": "TALRAJI",
"formSubjectId": "Testuser3908",
"creationDate": "/Date(1467617058000+0000)/",
"formReviewEndDate": "/Date(1451606399000+0000)/",
"rating": "0",
"isRated": false,
"formLastModifiedDate": "/Date(1467617058000+0000)/",
"formTitle": "1608 for User3908 Test",
"formContents": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(272L)/formContents"
}
},
"formSubject": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(272L)/formSubject"
}
},
"formRouteMap": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(272L)/formRouteMap"
}
}
}
Limitation
If you update the overall form rating to -1971 (Too New to Rate) or -1972 (Unrated) through the FormUserRatingComment
entity, you get the rating as 0 when you query the FormHeader entity.
Related Information
SAP API Business Hub: Forms Management
FormFolder
You can use this entity to query a list of form folders, including inbox, en route, and completed folders.
Permissions
10/19/2022
Query Query a list of form folders.

Use Case: Query Form Folders

The following example shows how to query a list of form folders in a system.
Request
Operation Query
HTTP Method GET
URI http://<api-server>/odata/v2/FormFolder?
$format=json
Response
{
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormFolder(477L)",
"type": "SFOData.FormFolder"
},
"folderId": "477",
"folderName": "\"EMENTESTING\"",
"userId": "hcheng",
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormFolder(477L)/form
}
}
},
{
"__metadata": {
},
"folderId": "27",
"folderName": "Completed",
"userId": "hcheng",
"forms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormFolder(27L)/forms
}
}
10/19/2022
},
{
"__metadata": {
"uri": "https://<api-server/odata/v2/FormFolder(26L)",
},
"folderId": "26",
"folderName": "En Route",
"userId": "hcheng",
"forms": {
"__deferred": {
}
}
},
{
"__metadata": {
},
"folderId": "25",
"folderName": "To-Do",
"userId": "hcheng",
"forms": {
"__deferred": {
}
}
},
{
"__metadata": {
},
"folderId": "383",
"folderName": "Folder1",
"userId": "hcheng",
"forms": {
"__deferred": {
}
}
},
{
"__metadata": {
},
"folderId": "382",
"folderName": "gggg1",
"userId": "hcheng",
"forms": {
"__deferred": {
}
10/19/2022
}
}
]
}
Related Information
FormContent
You can use this entity to query the form content of Performance Management and 360 Reviews forms, for example, form data
ID, form content ID, last modi ed date, and status.
Permissions
For more information about permissions, see Performance Management Form Entities.
Query Query the form content of a form. FormContentId and formDataId are required for the query
operation.
formContentId Form content ID. This is a business key.
formDataId Form data ID. This is a business key.
formSubjectId Form subject ID.
lastModi edDate Last modi ed date and time with timezone information.
status Status of the form content. The status eld takes one of the following values:
-1: Indicates the draft status.
3 (only for 360 Reviews): Indicates that the rater has completed their evaluation rating.
6 (only for 360 Reviews): Indicates that the form is in the evaluation stage.
7 (only for 360 Reviews): Indicates that the process owner can exclude a completed review from the
overall rating calculation.
8 (only for 360 Reviews): Indicates that the participant has declined the review.
9 (only for 360 Reviews): Indicates that the process owner has removed a participant from the
review.
10: Indicates that the form owner has viewed the form in the Inbox.
88 (only for 360 Reviews): A status exclusively for ad hoc forms. It indicates that the form was
declined passively after reaching the due date.
10/19/2022
Use Case: Query Form Content

The following example shows how to query the form content of a given form.
Request
Operation Query
HTTP Method GET
URI https://<api-
server>/odata/v2/FormContent(formContentId=61L,formDataId=151L)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormContent(formContentId=61L,formDataId=151L)",
"type": "SFOData.FormContent"
},
"formContentId": "61",
"lastModifiedDate": "/Date(1495746637000+0000)/",
"status": "-1",
"folders": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormContent(formContentId=61L,formDataId=151L
}
},
"formHeader": {
"__deferred": {
}
},
"pmReviewContentDetail": {
"__deferred": {
}
},
"form360ReviewContentDetail": {
"__deferred": {
}
}
}
}
Related Information
10/19/2022
SAP API Business Hub: Continuous Performance Management
FormPMReviewContentDetail
You can use this entity to get the basic information of different sections in Performance Management forms. The data of this
entity comes from form content XML.
Permissions
For more information about permissions, see Performance Management Form Entities.
Query Query to identify a speci c form. FormDataId and formContentId are required for the query operation.
Upsert Update sections in a speci c form. FormDataId and formContentId are required for the upsert operation.
Other than these values, you need key property values and comment/rating key values of entities to be
saved.

Use Case 1: Query Different Sections of a Form

The following example shows how to query the basic information of different sections in a given form.
Request
Operation Query
HTTP Method GET
URI https://<api-
server>/odata/v2/FormPMReviewContentDetail(formContentId=17617L,formDataId=7182L)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormPMReviewContentDetail(formContent
"type": "SFOData.FormPMReviewContentDetail"
},
"summarySection": {
"__deferred": {
10/19/2022
"uri": "https://<api-server>/odata/v2/FormPMReviewContentDetail(for
}
},
"signatureSection": {
"__deferred": {
}
},
"introductionSection": {
"__deferred": {
}
},
"competencySections": {
"__deferred": {
}
},
"objectiveSections": {
"__deferred": {
}
},
"userInformationSection": {
"__deferred": {
}
}
}
}
Use Case 2: Update a Competency Rating Comment

The following example shows how to update a competency rating comment in a given form.
Request
Operation Upsert
HTTP POST
Method
URI https://<api-server>/odata/v2/upsert
Payload
 Sample Code
{
"__metadata": {
"uri": "FormPMReviewContentDetail(formContentId=17549L,formDataId=7182L)",
},
"competencySections": [
{
"__metadata": {
"uri": "FormCompetencySection(formContentId=17549L,formDataId=7
"type": "SFOData.FormCompetencySection"
10/19/2022
},
"selfRatingComment": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=17549L,form
"type": "SFOData.FormUserRatingComment"
},
"commentKey": "wf_sect_4_sc_ user1_c",
"comment": "Section comment for role specific competencies by m
}
}
]
}
Response
{
"d": [
{
"key": "FormPMReviewContentDetail/formContentId=17549,FormPMReviewContentDe
"status": "OK",
"editStatus": "UPDATED",
"message": null,
"index": "0",
"httpCode": "200",
"inlineResults": null
}
]
}
Related Information
FormTemplate
You can use this entity to query the basic information of form templates, for example, template ID and name.
Permissions
Query Query the basic information of form

templates.
10/19/2022
Use Case: Query the Basic Information of Form Templates

The following example shows how to query the basic information of form templates in a system.
Request
Operation Query
HTTP Method GET
URI http://<api-server>/odata/v2/FormTemplate?
$format=json
Response
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormTemplate(116L)",
"type": "SFOData.FormTemplate"
},
"formTemplateName": "AYT-6039",
"associatedForms": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormTemplate(116L)/associatedForms"
}
}
}
Related Information
FormCompetency
You can use this entity to get the basic information of competencies in Performance Management and 360 Reviews forms. The
data of this entity comes from form content XML.
Permissions
10/19/2022
Query Query the basic information of competencies in a speci c form.

FormContentId, formDataId, itemId, and sectionIndex are required
for the query operation.
Upsert Update the self item comments, official ratings, and custom
elements of competencies in a speci c form.
 Note
To update item comments in 360 Reviews forms, use
selfRatingComment of FormCompetency. To update item ratings
in 360 Reviews forms, use officialRating of FormCompetency.
itemIndex The order of a competency in a form. You can use this property to
set the order of competencies in a form.
Use Case 1: Query the Basic Information of a Competency

The following example shows how to query the basic information of a competency in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormCompetency(formContentId=17617L,formDataId=7182L,itemId=7L,sectionInde
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetency(formContentId=17617L,f
"type": "SFOData.FormCompetency"
},
"sectionIndex": 4,
"itemId": "7",
"category": null,
"weight": "10.0",
"source": "",
10/19/2022
"description": "Builds customer confidence, is committed to increasing customer sat
"name": "Customer Focus",
"weightKey": "wf_sect_4__c7_w",
"expectedRating": "50.0%",
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCompetency(formContentId=
}
},
"officialRating": {
"__deferred": {
}
},
"othersRatingComment": {
"__deferred": {
}
},
"itemConfiguration": {
"__deferred": {
}
},
"competencyBehaviors": {
"__deferred": {
}
},
"customElement": {
"__deferred": {
}
}
}
}
Use Case 2: Update the Official Rating of a Competency

The following example shows how to update the official rating of a given competency.
Request
Operation Upsert
HTTP POST
Method
URI http://<api-server>/odata/v2/upsert
Payload
{
"__metadata": {
},
10/19/2022
{
"__metadata": {
},
"competencies": [
{
"__metadata": {
"uri": "FormCompetency(formContentId=17534L,form
},
"officialRating": {
"__metadata": {
"uri": "FormUserRatingComment(formConten
},
"ratingKey": "wf_sect_3__c17_r",
"rating": "4.0"
}
}
]
}
]
}
Response
{
"d": [
{
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormCompetencyBehavior
You can use this entity to get the basic information of competency behaviors in Performance Management and 360 Reviews
forms. The data of this entity comes from form content XML.
Permissions
10/19/2022
Query Query to identify the basic information of competency behaviors in a speci c form. FormDataId,
formContentId, sectionIndex, itemId, and behaviorId are required for the query operation.
Upsert Update the self item comments, official ratings, and custom elements of competency behaviors in a
speci c form. FormDataId, formContentId, sectionIndex, itemId, and behaviorId are required for the upsert
operation. Other than these values, you need key property values and comment/rating key values of
entities to be saved.
 Note
To update item comments in 360 Reviews forms, use selfRatingComment of FormCompetencyBehavior.
To update item ratings in 360 Reviews forms, use officialRating of FormCompetencyBehavior.

Use Case 1: Query the Basic Information of a Competency Behavior

The following example shows how to query the basic information of a competency behavior.
Request
Operation Query
HTTP Method GET
URI http://<api-server>/odata/v2/FormCompetencyBehavior
(formContentId=17536L,formDataId=7178L,sectionIndex=4,itemId=7L,behaviorId=46051)
?$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetencyBehavior(behaviorId=460
"type": "SFOData.FormCompetencyBehavior"
},
"sectionIndex": 4,
"behaviorId": "46051",
"itemId": "7",
"category": null,
"weight": null,
"description": "",
"behaviorName": "Maintains customer commitments",
"weightKey": null,
"expectedRating": null,
10/19/2022
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCompetencyBehavior(behavi
}
},
"officialRating": {
"__deferred": {
}
},
"__deferred": {
}
}
}
}
Use Case 2: Update a Behavior Rating Comment

The following example shows how to update the rating comment of a competency behavior.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetency(formContentId=17536L,formDa
},
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetencyBeha
},
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormBehavi
"type": "SFOData.FormBehaviorRatingComment"
},
"commentKey": "wf_sect_4__c7_46051_br",
"comment": "Five Star - Updated from API "
}
}
]
}
}
10/19/2022
Response
{
"d": [
{
"key": " FormCompetency/formContentId=17536,FormCompetency/formDataId=7178,
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormCompetencySection
You can use this entity to get the basic information of competency sections in Performance Management and 360 Reviews
forms. The data of this entity comes from form content XML.
Permissions
Query Query to identify a competency section in a speci c form. FormDataId, formContentId, and sectionIndex
are required for the query operation.
Upsert Update the self item comments, official ratings, and custom elements of competencies in a speci c form.
FormDataId, formContentId, and sectionIndex are required for the upsert operation. Other than these
values, you need key property values and comment/rating key values of entities to be saved.

Use Case 1: Query the Basic Information of a Competency Section

The following example shows how to query the basic information of a competency section.
Request
10/19/2022
Operation Query
HTTP Method GET
URI http://<api-server>/odata/v2/
FormCompetencySection(formContentId=17476L,formDataId=7153L,sectionIndex=3)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetencySection(formContentId=1
},
"sectionIndex": 3,
"sectionDescription": "",
"sectionWeightKey": "wf_sect_3_sectionWeight",
"sectionWeight": "30.0",
"sectionName": "Competencies",
"sectionConfiguration": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCompetencySection(formCon
}
},
"__deferred": {
}
},
"competencies": {
"__deferred": {
}
},
"__deferred": {
}
}
}
}
Use Case 2: Update the Rating Comment of a Competency Section

The following example shows how to update the rating comment of a competency section.
Request
Operation Upsert
10/19/2022
HTTP POST
Method
Payload
{
"__metadata": {
},
{
"__metadata": {
},
"__metadata": {
"uri": "FormUserRatingComment(formContentId=17549L,formD
},
"commentKey": "wf_sect_4_sc_manager1_c",
"comment": "Section comment for role specific competencies by Ma
}
}
]
}
Response
{
"d": [
{
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormBehaviorRatingComment
You can use this entity to get and update the ratings and comments of competency behaviors in Performance Management and
360 Reviews forms. The data of this entity comes from form content XML.
Permissions
10/19/2022
Query Query to identify a speci c user’s rating and comment of a competency behavior. FormDataId,
formContentId, sectionIndex, itemId, userId, ratingType, and behaviorId are required for the query
operation.
Upsert Update a speci c user’s rating and comment of a competency behavior.

Use Case 1: Query the Self Rating and Comment of a Competency Behavior
The following example shows how to query a speci c user's self rating and comment of a competency behavior.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormBehaviorRatingComment(formContentId=17536L,formDataId=7178L,behaviorId
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormBehaviorRatingComment(behaviorId=
},
"sectionIndex": 4,
"userId": "user1",
"ratingType": "na",
"behaviorId": "46051",
"itemId": "7",
"ratingPermission": "write",
"commentLabel": "Subjects Comments",
"lastName": "User LN",
"commentKey": "wf_sect_4__c46051_cmt_user1_c",
"textRating": "4.0 - 4",
"ratingKey": "wf_sect_4__c46051_cmt_user1_",
10/19/2022
"ratingLabel": "Rating",
"rating": "4.0",
"fullName": "User Name",
"commentPermission": "write",
"firstName": "User FN",
"comment": "Five Star - Updated from API Testing"
}
}
Use Case 2: Update the Rating Comment of a Competency Behavior

The following example shows how to update a speci c user's rating comment of a competency behavior.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetency(formContentId=17536L,formDa
},
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCompetencyBeha
},
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormBehavi
},
"commentKey": "wf_sect_4__c7_46051_br",
"comment": "Five Star - Updated from API "
}
}
]
}
}
Response
{
"d": [
{
"key": " FormCompetency/formContentId=17536,FormCompetency/formDataId=7178,
"status": "OK",
"message": null,
10/19/2022
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormObjective
You can use this entity to get and update the basic information of objectives in Performance Management forms. The data of
this entity comes from form content XML.
Permissions
Query Query the basic information of objectives in a speci c form.

FormContentId, FormDataId, sectionIndex, and itemId are required
for the query operation.
Upsert Update the self rating comment, official rating, and custom element
of objectives in a speci c form.
Navigation Property Related Entity Description
comments FormObjectiveComment Navigation to the FormObjectiveComment

entity
customElement FormCustomElement Navigation to the FormCustomElement

entity
itemCon guration FormItemCon guration Navigation to the FormItemCon guration

entity
objectiveDetails FormObjectiveDetails Navigation to the FormObjectiveDetails

entity
officialRating FormUserRatingComment Navigation to the FormUserRatingComment

entity
otherDetails FormObjectiveOtherDetails Navigation to the

FormObjectiveOtherDetails entity
othersRatingComment FormUserRatingComment Navigation to the FormUserRatingComment

entity
10/19/2022
selfRatingComment FormUserRatingComment Navigation to the FormUserRatingComment

entity
metricLookupTables FormObjectiveDetails Currently, this navigation property is not

supported.
milestones FormObjectiveDetails Currently, this navigation property is not

supported.
targets FormObjectiveDetails Currently, this navigation property is not

supported.
tasks FormObjectiveDetails Currently, this navigation property is not

supported.
Use Case 1: Query the Basic Information of an Objective

The following example shows how to query the basic information of an objective in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormObjective(formContentId=17476L,formDataId=7153L,itemId=4930L,sectionIn
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormObjective(formContentId=17476L,fo
"type": "SFOData.FormObjective"
},
"sectionIndex": 2,
"itemId": "4930",
"weight": null,
"done": "0.0",
"state": null,
"stateColor": null,
"category": "Customer",
"metric": "dsd",
"name": "d",
"weightKey": null,
"officialRating": {
10/19/2022
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormObjective(formContentId=1
}
},
"tasks": {
"__deferred": {
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"objectiveDetails": {
"__deferred": {
}
},
"customElement": {
"__deferred": {
}
},
"milestones": {
"__deferred": {
}
},
"__deferred": {
}
},
"targets": {
"__deferred": {
}
},
"metricLookupTables": {
"__deferred": {
}
}
}
}
Use Case 2: Update the Self Rating and Comment of an Objective
10/19/2022
The following example shows how to update the self rating and comment of an objective in a given form.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
},
"objectiveSections": [
{
"__metadata": {
"uri": "FormObjectiveSection(formContentId=17534L,formDataId=717
"type": "SFOData.FormObjectiveSection"
},
"objectives": [
{
"__metadata": {
"uri": "FormObjective(formContentId=17534L,formD
},
"__metadata": {
},
"ratingKey": "wf_sect_2_o_0_cmt_manager1_",
"rating": "4.0",
"commentKey": "wf_sect_2_o_0_cmt_manager1_c",
"comment": "TGM goal Manager comment"
}
}
]
}
]
}
Response
{
"d": [
{
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
10/19/2022
]
}
Use Case 3: Retrieve Objective Details from FormObjective

The following example shows how to retrieve the detailed information of an objective from FormObjective.
Request
Operation Query
HTTP GET
Method
URI https://<api-
server>/odata/v2/FormObjective(formContentId=728L,formDataId=955L,sectionIndex=2,itemId=502
$expand=objectiveDetails
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormObjective(formContentId=17476L,formDataId=7153L,ite
},
"sectionIndex": 2,
"itemId": "4930",
"weight": null,
"done": "0.0",
"state": null,
"stateColor": null,
"category": "Customer",
"metric": "dsd",
"name": "d",
"weightKey": null,
"officialRating": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormObjective(formContentId=17476L,formDataId=7153L,i
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"objectiveDetails": {
10/19/2022
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormObjectiveDetails(formContentId=17476L,formDat
"type": "SFOData.FormObjectiveDetails"
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "name",
"value": "d"
},
{
"__metadata": {
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "metric",
"value": "dsd"
},
{
"__metadata": {
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "state",
"value": "Not Started"
},
{
"__metadata": {
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "start",
"value": "01/01/2010"
},
{
"__metadata": {
10/19/2022
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "due",
"value": "12/31/2010"
},
{
"__metadata": {
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"id": "done",
"value": "0.0%"
},
{
"__metadata": {
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "weight",
"value": "0.000"
},
{
"__metadata": {
},
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "actual-achievement",
"value": ""
},
{
"__metadata": {
},
10/19/2022
"sectionIndex": 2,
"type": 0,
"itemId": "4930",
"fieldId": "rating",
"value": ".00"
}
]
},
"customElement": {
"__deferred": {
}
},
"__deferred": {
}
}
}
}
Related Information
FormObjectiveDetails
You can use this entity to query the detailed information of objectives in Performance Management forms. The data of this
Permissions
Query Query to identify the detailed information of a speci c objective in a speci c form. FormDataId,
formContentId, sectionIndex, itemId, and type are required for the query operation.
 Note
Currently, type=1/2/3/4 is not supported.

10/19/2022
Use Case: Query the Detailed Information of an Objective

The following example shows how to query the detailed information of a speci c objective in a given form.
Request
Operation Query
HTTP GET
Method
URI https://<api-
server>/odata/v2/FormObjectiveDetails(formContentId=18442L,formDataId=10520L,itemId=4524L,s
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormObjectiveDetails(formContentId=18442L,formDataId=10
},
"sectionIndex": 3,
"type": 0,
"itemId": "4524",
"value": "Персональная цель",
"label": "Категория",
"fieldId": "TargetTeamOrPrivate",
"fieldDataType": "enum"
}
}
Related Information
FormObjectiveSection
You can use this entity to get the basic information of goal sections in Performance Management and 360 Reviews forms. The
Permissions
Query
10/19/2022

Use Case: Query Basic Information of a Goal Section

Request
Operation Query
HTTP GET
Method
URI https://<api-
server>/odata/v2/FormObjectiveSection(formContentId=36440L,formDataId=32000L,sectionIndex=2
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormObjectiveSection(formContentId=36440L,formDat
},
"sectionIndex": 2,
"sectionName": "Goals",
"sectionDescription": "\nThis section is for evaluating accomplishments of goals. \n<br /><
"sectionWeightKey": "wf_sect_2_sectweight",
"objPlanId": "10",
"objPlanType": "Business",
"sectionWeight": "50.0",
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormObjectiveSection(formContentId=36440L,for
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"objectives": {
"__deferred": {
}
10/19/2022
}
}
}
FormUserRatingComment
You can use this entity to get and update the ratings and comments of the objective, competency, custom, signature, and
summary sections in Performance Management forms. The data of this entity comes from form content XML.
Permissions
Query Query to identify a speci c user’s rating and comment in a speci c form. FormDataId, formContentId,
sectionIndex, itemId, userId, and ratingType are required for the query operation.
Upsert Update a speci c user’s rating and comment.

Use Case 1: Query the Rating and Comment of a Competency

The following example shows how to query a user's rating and comment of a competency in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormUserRatingComment(formContentId=17617L,formDataId=7182L,itemId=7L,rati
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormUserRatingComment(formContentId=1
},
"sectionIndex": 4,
10/19/2022
"userId": "user1",
"ratingType": "na",
"itemId": "7",
"commentLabel": "Managers Comments",
"lastName": "LN",
"commentKey": "wf_sect_4__c7_cmt_user1_c",
"textRating": "Select a rating...",
"ratingKey": "wf_sect_4__c7_cmt_user1_",
"ratingLabel": "Self Rating",
"rating": "-1972.0",
"fullName": "User 1",
"commentPermission": "write",
"firstName": "FN",
"comment": ""
}
}
Use Case 2: Update the Rating and Comment of an Objective

The following example shows how to update a user's rating and comment of an objective in a given form.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
},
"objectiveSections": [
{
"__metadata": {
"uri": "FormObjectiveSection(formContentId=31902L,formDataId=287
},
"objectives": [
{
"__metadata": {
"uri": "FormObjective(formContentId=31902L,formD
},
"__metadata": {
},
"ratingKey": "wf_sect_1_o_2_r",
"rating": "1.0",
10/19/2022
"commentKey": "wf_sect_3_o_1_cmt_manager1_c",
"comment": "obj 601 added by api wf_sect_3_o_1_c
}
}
]
}
]
}
Response
{
"d": [
{
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormCustomElement
You can use this entity to get and update the basic information of custom elements added to objectives and competencies in
Performance Management forms. The data of this entity comes from form content XML.
Permissions
Query Query to identify a custom element in a speci c form. FormDataId, formContentId, sectionIndex, itemId,
and elementKey are required for the query operation.
Upsert Update the custom element value in a speci c form. FormDataId, formContentId, sectionIndex, itemId, and
elementKey are required for the upsert operation. Other than these values, you need key property values
and key values of entities to be saved.
10/19/2022
Use Case 1: Query the Basic Information of a Custom Element

The following example shows how to query the basic information of a custom element in a given form section.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormCustomElement(formContentId=17628L,formDataId=7176L,itemId=14L,section
$format=json
Response
 Sample Code
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCustomElement(elementKey='ele_0
"type": "SFOData.FormCustomElement"
},
"sectionIndex": 3,
"elementKey": "ele_0",
"itemId": "14",
"valueKey": "wf_sect_3__c14_ele_00",
"name": "CE3 List",
"minimumValue": "0.0",
"value": "T3",
"writingAssistant": true,
"type": "LIST",
"required": false,
"textMaximumLength": -1,
"checked": false,
"editable": true,
"maximumValue": "0.0",
"elementListValues": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCustomElement(elementKe
}
}
}
}
10/19/2022
Use Case 2: Update the Custom Element Value of a Competency

The following example shows how to update the custom element value of a given competency.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
},
{
"__metadata": {
},
"competencies": [
{
"__metadata": {
"uri": "FormCompetency(formContentId=17628L,form
},
"customElement": [
{
"__metadata": {
"uri": "FormCustomElement(formCo
"type": "SFOData.FormCustomEleme
},
"value": "T3"
},
{
"__metadata": {
"uri": "FormCustomElement(formCo
"type": "SFOData.FormCustomEleme
},
"value": "My text elm value"
}
]
}
]
}
]
}
Response
{
"d": [
{
10/19/2022
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormCustomElementListValue
You can use this entity to get the basic information of custom list elements added to competencies and objectives. The data of
Permissions
Query Query to identify a custom list element in a speci c form. FormDataId, formContentId, sectionIndex,
itemId, name, and elementKey are required for the query operation.

Use Case: Query the Basic Information of a Custom List Element

The following example shows how to query the basic information of a custom list element in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormCustomElementListValue(elementKey='ele_0',formContentId=17628L,formDat
$format=json
10/19/2022
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCustomElementListValue(elementKey
"type": "SFOData.FormCustomElementListValue"
},
"sectionIndex": 3,
"elementKey": "ele_0",
"name": "",
"itemId": "14",
"selected": false,
"value": "T1",
"listIndex": -1
}
}
Related Information
FormCustomSection
You can use this entity to get the basic information of custom sections in Performance Management forms. The data of this
Permissions
Query, Upsert

Use Case: Query Basic Information of a Custom Section

Request
Operation Query
HTTP GET
Method
10/19/2022
URI https://<api-
server>/odata/v2/FormCustomSection(formContentId=36461L,formDataId=32050L,sectionIndex=6)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCustomSection(formContentId=36461L,formDataId
"type": "SFOData.FormCustomSection"
},
"sectionIndex": 6,
"sectionName": "Custom",
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCustomSection(formContentId=36461L,formDa
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"customElement": {
"__deferred": {
}
}
}
}
Use Case: Update Comments of a Custom Section

Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCustomSection(formContentId=36461L,formDataId=
10/19/2022
"type": "SFOData.FormCustomSection"
},
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCustomSection(formContentId=36461L,formDat
},
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormUserRatingComment(formContentId=36461L,for
"type": "SFOData.FormUserRatingComment"},
"commentKey": "wf_sect_6_sc_sfadmin_c",
"comment": "Section comments"
},
"results": []
},
"customElement": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCustomSection(formContentId=36461L,formDataId=
}
}
Response
<d:key>FormCustomSection/formContentId=36461,FormCustomSection/formDataId=32050,FormCustomSection/s
<d:status>OK</d:status>
<d:editStatus m:null="true"></d:editStatus>
<d:message></d:message>
<d:index m:type="Edm.Int32">0</d:index>
<d:httpCode m:type="Edm.Int32">200</d:httpCode>
<d:inlineResults m:type="Bag(SFOData.UpsertResult)"></d:inlineResults>
FormSectionCon guration
You can use this entity to get the con guration details of the objective, competency, custom, and summary sections in
Performance Management forms. The data of this entity comes from form content XML.
Permissions
Query Query to identify section con guration in a speci c form. FormDataId, formContentId, and sectionIndex are

10/19/2022
Use Case: Query Section Con guration

The following example shows how to query the con guration details of a section in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormSectionConfiguration(formContentId=17617L,formDataId=7182L,sectionInde
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormSectionConfiguration(formContentId=17617L,for
"type": "SFOData.FormSectionConfiguration"
},
"sectionIndex": 4,
"sectionWeightPermission": "write",
"sectionCommentRequired": false,
"hasItemComment": true,
"addItem": false,
"ratingOption": 2,
"weightTotal": "-1.0",
"enforceRTECharacterLimit": false,
"enforcePlainTextCharacterLimit": false,
"rateByBehavior": false,
"hasSectionComment": true,
"behaviorModeOption": 0,
"ezRaterEnabled": true
"ezRaterExpandAll": false
"formRatingScale": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormSectionConfiguration(formContentId=17617L
}
},
"formBehaviorRatingScale": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormSectionConfiguration(formContentId=17617L
}
}
}
}
Related Information
10/19/2022
FormItemCon guration
You can use this entity to get the con guration details of objective and competency items in Performance Management forms.
The data of this entity comes from form content XML.
Permissions
Query Query to identify item con guration in a speci c form. FormDataId, formContentId, sectionIndex, and
itemId are required for the query operation.

Use Case: Query Item Con guration

The following example shows how to query the con guration details of an item in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormItemConfiguration(formContentId=17546L,formDataId=7181L,sectionIndex=5
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormItemConfiguration(formContentId=1
"type": "SFOData.FormItemConfiguration"
},
"sectionIndex": 5,
"itemId": "43",
"suppressItemComments": false,
10/19/2022
"suppressItemCommentsLabel": false,
"itemWeightRequired": false,
"itemRatingRequired": false,
"itemEditable": false,
"behaviorRemovable": false,
"itemCommentRequired": false,
"itemWeightPermission": "none",
"itemRemovable": false
}
}
Related Information
FormIntroductionSection
You can use this entity to get the basic information of the introduction section in Performance Management forms. The data of
Permissions
Query Query the basic information of the introduction section in a speci c form. FormDataId and formContentId
are required for the query operation.

Use Case: Query the Basic Information of the Introduction Section

The following example shows how to query the basic information of the introduction section in in a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormIntroductionSection(formContentId=17639L,formDataId=7221L)?
$format=json
Response
10/19/2022
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormIntroductionSection(formContentId
"type": "SFOData.FormIntroductionSection"
},
"sectionDescription": "This is form introduction details.",
"sectionIndex": 0,
"sectionName": "Introduction"
}
}
Related Information
FormUserInformationSection
You can use this entity to get the form subject information in the user information section in Performance Management forms.
Permissions
Query Query the user information section of a speci c form. FormDataID and formContentID are required for the
query operation.

Use Case: Query the User Information Section

The following example shows how to query the user information section in a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormUserInformationSection(formContentId=17476L,formDataId=7153L)?
$format=json
10/19/2022
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormUserInformationSection(formConten
"type": "SFOData.FormUserInformationSection"
},
"section Description ": "",
"sectionIndex": 0,
"sectionName": "Employee Information",
"userInformationElements": {
"__deferred": {
"uri": "https:// <api-server>/odata/v2/FormUserInformationSection(f
}
}
}
}
Related Information
FormSummarySection
You can use this entity to get and update the basic information of the summary section in Performance Management forms. The
Permissions
Query Query to identify the summary section in a speci c form. FormDataId and formContentId are required for
the query operation.
Upsert Update the summary section in a speci c form. FormDataId, formContentId, sectionIndex, itemId,
ratingType, and userId are required for the upsert operation. Other than these values, you need key
property values and comment/rating key values of entities to be saved.

10/19/2022
Use Case 1: Query the Basic Information of the Summary Section

The following example shows how to query the basic information of the summary section in a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormSummarySection(formContentId=17628L,formDataId=7176L)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormSummarySection(formContentId=1762
"type": "SFOData.FormSummarySection"
},
"sectionIndex": 4,
"sectionName": "Performance Summary",
"overallAdjustedRating": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormSummarySection(formConten
}
},
"__deferred": {
}
},
"__deferred": {
}
},
"calculatedFormRating": {
"__deferred": {
}
},
"overallFormRating": {
"__deferred": {
}
},
"__deferred": {
10/19/2022
}
}
}
}
Use Case 2: Update Overall Form Rating

The following example shows how to update the overall form rating in the summary section.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
},
"summarySection": {
"__metadata": {
"uri": "FormSummarySection(formContentId=17628L,formDataId=7176L)",
"type": "SFOData.FormSummarySection"
},
"overallFormRating": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=17628L,formDataId=71
},
"ratingKey": "wf_sect_4_rating",
"rating": "4.0"
}
}
}
Response
{
"d": [
{
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
10/19/2022
Related Information
FormSignatureSection
You can use this entity to get and update the basic information of the signature section in Performance Management forms.
The data of this entity comes from form content XML.
Permissions
Query Query to identify the signature section in a speci c form. FormDataId, formContentId, and sectionIndex are
Upsert Update the signature section. FormDataId, formContentId, sectionIndex, stepId, itemId, ratingType, and
userId are required for the upsert operation. Other than these values, you need key property values and
comment/rating key values of entities to be saved.

Use Case 1: Query the Basic Information of the Signature Section

The following example shows how to query the basic information of the signature section in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormSignatureSection(formContentId=17629L,formDataId=7181L,sectionIndex=9)
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormSignatureSection(formContentId=17
"type": "SFOData.FormSignatureSection"
},
10/19/2022
"sectionIndex": 9,
"sectionDescription": "Employee signature does not imply agreement or disagreement,
"sectionName": "Signatures",
"signatures": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormSignatureSection(formCont
}
}
}
}
Use Case 2: Update Section Comments

The following example shows how to update the section comments in the signature section.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
},
"signatureSection": {
"__metadata": {
"uri": "FormSignatureSection(formContentId=17629L,formDataId=7181L,secti
"type": "SFOData.FormSignatureSection"
},
"signatures": [
{
"__metadata": {
"uri": "FormSignature(formContentId=17629L,formDataId=71
"type": "SFOData.FormSignature"
},
"comment": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=1762
},
"commentKey": "wf_sect_9_sc_user1_c",
"comment": "Signature comment by user1-updated"
}
}
]
}
}
Response
10/19/2022
{
"d": [
{
"status": "OK",
"message": null,
"index": "0",
"httpCode": "200",
}
]
}
Related Information
FormSignature
You can use this entity to get signature information in Performance Management forms. The data of this entity comes from
form content XML.
Permissions
Query Query to identify signature information in a speci c form. FormDataId, formContentId, sectionIndex, and
stepId are required for the query operation.

Use Case: Query Signature Information

The following example shows how to query signature information in a given form.
Request
Operation Query
HTTP GET
Method
10/19/2022
URI http://<api-
server>/odata/v2/FormSignature(formContentId=17629L,formDataId=7181L,sectionIndex=9,stepId=
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormSignature(formContentId=17629L,fo
"type": "SFOData.FormSignature"
},
"sectionIndex": 9,
"stepId": "154992821696258",
"signedBy": "User1",
"status": "current",
"signedDate": null,
"roleType": "Employee:",
"actionInformation": null,
"stepOrder": 0,
"comment": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormSignature(formContentId=1
}
}
}
}
Related Information
FormRatingScale
You can use this entity to get the basic information of the rating scales associated with the competency, objective, and
summary section in Performance Management forms.
Permissions
Query Query to get the rating scale associated with the competency, objective, or summary section in a speci c
form. FormDataId, formContentId, and sectionIndex are required for the query operation.

10/19/2022
Use Case: Query the Basic Information of a Rating Scale

The following example shows how to query the rating scale that is associated with the competency, objective, or summary
section in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormRatingScale(formContentId=17628L,formDataId=7176L,sectionIndex=2)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormRatingScale(formContentId=17628L,
"type": "SFOData.FormRatingScale"
},
"sectionIndex": 2,
"showValue": true,
"scaleId": "2005b",
"scaleType": "STAR",
"name": "2005b",
"reverseScale": false,
"ratingScaleList": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormRatingScale(formContentId
}
}
}
}
Related Information
FormRatingScaleValue
You can use this entity to get the basic information of the rating scale values associated with the competency, objective, and
summary section in Performance Management forms.
10/19/2022
Permissions
Query Query to identify the rating scale value associated with the competency, objective, or summary section in a
speci c form. FormDataId, formContentId, sectionIndex, scaleId, and value are required for the query
operation.

Use Case: Query the Basic Information of a Rating Scale Value

The following example shows how to query the rating scale value that is associated with the competency, objective, or summary
section in a given form.
Request
Operation Query
HTTP GET
Method
URI http://<api-
server>/odata/v2/FormRatingScaleValue(formContentId=17628L,formDataId=7176L,scaleId='2005b'
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormRatingScaleValue(formContentId=17
"type": "SFOData.FormRatingScaleValue"
},
"sectionIndex": 2,
"scaleId": "2005b",
"value": "2.0",
"description": "Needs Development",
"longDescription": null
}
}
Related Information
10/19/2022
TalentRatings
You can use this entity to get feedback details in Performance Management forms, for example, form data ID, feedback type,
rating value, and rating label.
Permissions
If you have OData API access permission, you can access this entity based on the following two permissions:
If you want to access this entity directly, make sure that you have the permission of Admin Access to Talent Rating OData
API.
If you want to expand this entity as a navigation property from parent entities, make sure that you also have permission
to the parent entities.
API Permissions
Permission System Required Settings
Role based
In Manage Documents , select Admin Access to Talent
Rating OData API.
In Manage Calibration , select OData API Calibration

Export.
Query Query feedback details in a speci c form.

Use Case: Query Form Feedback Details

The following example shows how to query feedback details in a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-server>/odata/v2/TalentRatings?
$format=json&$filter=formDataId eq
1459L&$orderBy=formContentId desc
10/19/2022
Response
{
results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/TalentRatings(34913L)",
"type": "SFOData.TalentRatings"
},
"feedbackId": "34913",
"feedbackModule": 1,
"feedbackSource": 1,
"feedbackRatingLabel": "Satisfactory with Commendation",
"feedbackScaleMinimum": "1",
"feedbackType": 2,
"employeeId": "user1",
"feedbackScaleMaximum": "5",
"feedbackRating": "4",
"feedbackName": "Increase Referencability of Customer in my Territory",
"feedbackWeight": "20",
"employeeUser": {
"__deferred":{
"uri": https://<api-server>/odata/v2/TalentRatings(34913L)/employeeUser"
}
},
"calSession": {
"__deferred":{
"uri": https://<api-server>/odata/v2/TalentRatings(34913L)/calSession"
}
}
},
{
"__metadata": {
},
"feedbackRatingLabel": null,
"feedbackType": 11,
"feedbackScaleMaximum": "-1972",
"feedbackRating": "-1972",
"feedbackName": "Individual Goals",
"employeeUser": {
"__deferred":{
10/19/2022
}
},
"calSession": {
"__deferred":{
}
}
},
{
"__metadata": {
},
"feedbackRatingLabel": "Meets Expectations",
"feedbackType": 1,
"feedbackName": "Listening Skills",
"feedbackWeight" : "15",
"employeeUser": {
"__deferred":{
}
},
"calSession": {
"__deferred":{
}
}
},
{
"__metadata": {
},
"feedbackRatingLabel": "Satisfactory with Commendation",
"feedbackType": 1,
"feedbackName": "Leadership",
10/19/2022
"employeeUser": {
"__deferred":{
}
},
"calSession": {
"__deferred":{
}
}
},
{
"__metadata": {
"type" : "SFOData.TalentRatings"
},
"feedbackRatingLabel": "Meets Expectations",
"feedbackType": 8,
"feedbackName": null,
"feedbackWeight": "-1972",
"employeeUser": {
"__deferred":{
}
},
"calSession": {
"__deferred":{
}
}
}
]
}
Related Information
SAP API Business Hub: Calibration
Retrieving Metadata
FormPerfPotSummarySection
You can use this entity to get the Performance Potential Summary Section details from the Performance Management form.
You can also update the overall Performance and Potential rating and section comments in the form.
10/19/2022
Permissions
Role based Manage Documents Admin Access to Forms OData API
User based None
Query Query the Performance Potential Summary Section details of a

given form
Upsert Update the overall Performance and Potential rating and section
comments of a given form

Navigation Properties
performanceRating FormUserRatingComment Represents the overall Performance rating

in the Performance Potential Summary
Section
potentialRating FormUserRatingComment Represents the overall Potential rating in the

Performance Potential Summary Section
sectionComment FormUserRatingComment Represents the section comments in the

Performance Potential Summary Section
Use Case 1: Query the Performance Potential Summary Section

This example shows how to query the Performance Potential Summary Section details for a given form with speci c criteria.
Request
Operation Query
HTTP Method GET
URI https://<API-endpoint-
URL>/odata/v2/FormPerfPotSummarySection(formContentId=30543L,formDataId=16677L)?
$format=json&$expand=performanceRating,potentialRating
Response
10/19/2022
{
"d": {
"__metadata": {
"uri": "https://<API-endpoint-URL>/odata/v2/FormPerfPotSummarySection(formContentId=305
"type": "SFOData.FormPerfPotSummarySection"
},
"sectionIndex": 5,
"sectionName": "Performance Potential Summary",
"othersSectionComments": {
"__deferred": {
"uri": "https://<API-endpoint-URL>/odata/v2/FormPerfPotSummarySection(formContentId
}
},
"performanceRating": {
"__metadata": {
"uri": "https://<API-endpoint-URL>/odata/v2/FormUserRatingComment(formContentId=305
},
"sectionIndex": 5,
"itemId": "0",
"ratingType": "perf",
"userId": "",
"firstName": null,
"lastName": null,
"ratingLabel": "PERFORMANCE",
"commentLabel": null,
"commentPermission": "none",
"commentKey": null,
"rating": "2.0",
"fullName": null,
"ratingPermission": "read",
"comment": null,
"ratingKey": "formMatrix_rowRatingSelectionList",
"textRating": "2.0 - Needs Development"
},
"potentialRating": {
"__metadata": {
},
"sectionIndex": 5,
"itemId": "0",
"ratingType": "pot",
"userId": "",
"firstName": null,
"lastName": null,
"ratingLabel": "POTENTIAL",
10/19/2022
"commentKey": null,
"rating": "3.0",
"fullName": null,
"ratingPermission": "read",
"comment": null,
"ratingKey": "formMatrix_colRatingSelectionList",
"textRating": "3.0 - Meets Expectations"
},
"__deferred": {
}
},
"sectionComment": {
"__deferred": {
}
}
}
}
Use Case 2: Update the Overall Performance and Potential Rating

This example shows how to update the overall Performance and Potential rating in the Performance Potential Summary
Section.
Request
Operation Upsert
HTTP POST
Method
URI https://<API-endpoint-URL>/odata/v2/upsert
Payload
{
"__metadata": {
"uri": "FormPerfPotSummarySection(formContentId=30543L,formDataId=16677L)"
},
"performanceRating": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=30543L,formDataId=16677L,itemId=0L,r
},
"rating": "1.0",
"ratingKey": "formMatrix_rowRatingSelectionList"
},
"potentialRating": {
"__metadata": {
},
"rating": "2.0",
"ratingKey": "formMatrix_colRatingSelectionList"
}
}
10/19/2022
Response
{
"d": [
{
"key": "FormPerfPotSummarySection/formContentId=30543,FormPerfPotSummarySection/formDat
"status": "OK",
"editStatus": null,
"message": "",
"index": 0,
"httpCode": 200,
}
]
}
Use Case 3: Update the Section Comments

This example shows how to update the section comments in the Performance Potential Summary Section.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "FormPerfPotSummarySection(formContentId=3624L,formDataId=4600L)",
"type": "SFOData.FormPerfPotSummarySection"
},
"sectionComment": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=3624L,formDataId=4600L,itemId=0L,ratingT
},
"commentKey": "wf_sect_3_sc_yaoe_c",
"comment": "Fantastic performance!"
}
}
Response
{
"d": [
{
"key": "FormPerfPotSummarySection/formContentId=3624,FormPerfPotSummarySection/formData
"status": "OK",
"editStatus": null,
"message": "",
"index": 0,
"httpCode": 200,
10/19/2022
}
]
}
Related Information
FormObjCompSummarySection
You can use this entity to get the Objective Competency Summary Section details which include overall, adjusted, and
calculated rating information from the Performance Management form review section. You can also update the Overall
Objective Rating, Overall Competency Rating, and section comments in the form.
Permissions
Role based Manage Documents Admin Access to Forms OData API
User based None
Query Query the Objective Competency Summary Section details of a

given form
Upsert Update the Overall Objective Rating, Overall Competency Rating,

and section comments of a given form

Navigation Properties
overallObjRating FormUserRatingComment Represents the Overall Objective Rating in

the Objective Competency Summary
Section
overallCompRating FormUserRatingComment Represents the Overall Competency Rating

in the Objective Competency Summary
Section
sectComment FormUserRatingComment Represents the section comments in the

Objective Competency Summary Section
10/19/2022
Use Case 1: Query the Objective Competency Summary Section Details

This example shows how to query the Objective Competency Summary Section details for a given form with speci c criteria.
Request
Operation Query
HTTP Method GET
URI https://<API-endpoint-
URL>/odata/v2/FormObjCompSummarySection(formContentId=30543,formDataId=16677L)?
$format=json&$expand=overallCompRating,overallObjRating
Response
{
"d": {
"__metadata": {
"uri": "https://<API-endpoint-URL>/odata/v2/FormObjCompSummarySection(formContentId=305
"type": "SFOData.FormObjCompSummarySection"
},
"sectionIndex": 6,
"sectionCommentsLabel": "Section Comments:",
"sectionName": "Objective Competency Summary",
"calculatedCompRating": {
"__deferred": {
"uri": "https://<API-endpoint-URL>/odata/v2/FormObjCompSummarySection(formContentId
}
},
"overallObjRating": {
"__metadata": {
},
"sectionIndex": 6,
"itemId": "0",
"ratingType": "sect_overall_objective",
"userId": "",
"firstName": null,
"lastName": null,
"ratingLabel": "Overall Form Rating:",
"commentKey": null,
"rating": "3.0",
"fullName": null,
"comment": null,
"ratingKey": "wf_sect_6_orating",
10/19/2022
"textRating": "3.0 - Meets Expectations"
},
"adjustedCompRating": {
"__deferred": {
}
},
"sectComment": {
"__deferred": {
}
},
"othersSectionComments": {
"__deferred": {
}
},
"ococRating": {
"__deferred": {
}
},
"adjustedObjRating": {
"__deferred": {
}
},
"calculatedObjRating": {
"__deferred": {
}
},
"__deferred": {
}
},
"compRatingScale": {
"__deferred": {
}
},
"objRatingScale": {
"__deferred": {
}
},
"overallCompRating": {
"__metadata": {
},
"sectionIndex": 6,
"itemId": "0",
10/19/2022
"ratingType": "sect_overall_competency",
"userId": "",
"firstName": null,
"lastName": null,
"ratingLabel": "Overall Form Rating:",
"commentKey": null,
"rating": "1.0",
"fullName": null,
"comment": null,
"ratingKey": "wf_sect_6_crating",
"textRating": "1.0 - Unsatisfactory"
}
}
}
Use Case 2: Update the Overall Objective Rating and Overall Competency Rating
This example shows how to update the Overall Objective Rating and Overall Competency Rating in the Objective Competency
Summary Section.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "FormObjCompSummarySection(formContentId=30543L,formDataId=16677L)"
},
"overallObjRating": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=30543L,formDataId=16677L,itemId=0L,ratin
},
"rating": "2.0",
"ratingKey": "wf_sect_6_orating"
},
"overallCompRating": {
"__metadata": {
},
"rating": "3.0",
"ratingKey": "wf_sect_6_crating"
}
}
Response
10/19/2022
{
"d": [
{
"key": "FormObjCompSummarySection/formContentId=30543,FormObjCompSummarySection/formDat
"status": "OK",
"editStatus": null,
"message": "",
"index": 0,
"httpCode": 200,
}
]
}
Use Case 3: Update the Section Comments

This example shows how to update the section comments in the Objective Competency Summary Section.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "FormObjCompSummarySection(formContentId=3624L,formDataId=4600L)",
"type": "SFOData.FormObjCompSummarySection"
},
"sectComment": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=3624L,formDataId=4600L,itemId=0L,ratingT
},
"commentKey": "wf_sect_2_sc_yaoe_c",
"comment": "Quite ordinary!"
}
}
Response
{
"d": [
{
"key": "FormObjCompSummarySection/formContentId=3624,FormObjCompSummarySection/formData
"status": "OK",
"editStatus": null,
"message": "",
"index": 0,
"httpCode": 200,
}
10/19/2022
]
}
Related Information
FormCustomizedWeightedRatingSection
You can use this entity to get the Customized Weighted Rating section details in Performance Management forms and update
the manual rating in the section.
Query, Upsert.

Use Case: Querying the Customized Weighted Rating Section

This example shows how to query the Customized Weighted Rating section details for a given form with speci c criteria.
Request
Operation Query
HTTP GET
Method
URI https://<api-
server>/odata/v2/FormCustomizedWeightedRatingSection(formContentId=32492L,formDataId=17253L
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormCustomizedWeightedRatingSection(formContentId
"type": "SFOData.FormCustomizedWeightedRatingSection"
},
"sectionIndex": 1,
"sectionName": "Customized Weighted Rating",
"calculatedRating": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormCustomizedWeightedRatingSection(formConte
10/19/2022
}
},
"__deferred": {
}
},
"manualRating": {
"__deferred": {
}
}
}
}
Use Case: Update the Manual Rating

This example shows how to update the manual rating in the Customized Weighted Rating section.
Request
Operation Upsert
HTTP POST
Method
Payload
{
"__metadata": {
"uri": "FormCustomizedWeightedRatingSection(formDataId=17253L,formContentId=32492L)",
"type": "SFOData.FormCustomizedWeightedRatingSection"
},
"manualRating": {
"__metadata": {
"uri": "FormUserRatingComment(formContentId=32492L,formDataId=17253L,itemId=0L,ratin
},
"ratingKey": "wf_sect_1_rating",
"rating": "2.0"
}
}
Response
{
"d": [
{
"key": "FormCustomizedWeightedRatingSection/formContentId=32492,FormCustomizedWeightedR
"status": "OK",
"editStatus": null,
"message": "",
"index": 0,
"httpCode": 200,
10/19/2022
}
]
}
Related Information
FormPerfPotSummarySection
FormAuditTrail
You can use this entity to get the audit trail information about Performance Management forms to track form routing details.
Permissions
To access all audit trail records of forms in the system, you should have the Administrator Manage Documents Admin Access
to Forms OData API permission.
Query Query to get the audit trail details about a given form. AuditTrailId is required for the query
operation.

Use Case 1: Query the Audit Trail Details About a Form

The following example shows how to query the audit trail details about a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormAuditTrail(auditTrailId=423L)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormAuditTrail(423L)",
"type": "SFOData.FormAuditTrail"
10/19/2022
},
"auditTrailId": "423",
"auditTrailRecipient": "101147",
"auditTrailAction": "submit",
"formContentAssociatedStepId": "104654026225696",
"auditTrailSender": "admin",
"auditTrailLastModified": "/Date(1505201829000+0000)/",
"auditTrailCoSender": null,
"auditTrailComment": "Creation.",
"formDataId": "87",
"auditTrailSendProxy": null,
"formContent": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormAuditTrail(423L)/formContent"
}
},
"formHeader": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormAuditTrail(423L)/formHeader"
}
}
}
}
Use Case 2: Retrieve Audit Trail Details from FormHeader

The following example shows how to retrieve the audit trail details about a given form from the parent entity FormHeader.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormHeader(formDataId=87L)?
$expand=formAuditTrails&$format=json
Response
{
"d": {
"__metadata": {
},
"formDataId": "87",
"dateAssigned": "/Date(1505201897000+0000)/",
"formOriginator": "admin",
"formSubjectId": "101147",
"sender": "101147",
10/19/2022
"currentStep": "EM",
"stepDueDate": null,
"formTitle": "Impax-GDPR for Brian A Meta",
"rating": "0",
"isRated": false,
"formFeedbackList": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formFeedbackList"
}
},
"formTemplate": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formTemplate"
}
},
"formLastContent": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formLastContent"
}
},
"formContents": {
"__deferred": {
}
},
"formSender": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formSender"
}
},
"formAuditTrails": {
"results": [
{
"__metadata": {
},
"auditTrailRecipient": "101147",
"auditTrailAction": "submit",
"auditTrailSender": "admin",
"auditTrailComment": "Creation.",
"formDataId": "87",
"formContent": {
10/19/2022
"__deferred": {
}
},
"formHeader": {
"__deferred": {
}
}
},
{
"__metadata": {
},
"auditTrailRecipient": "admin",
"auditTrailAction": "manual_approve",
"auditTrailSender": "101147",
"auditTrailComment": "Approved and routed on behalf of bmeta by admin. ",
"formDataId": "87",
"formContent": {
"__deferred": {
}
},
"formHeader": {
"__deferred": {
}
}
}
]
},
"formAttachments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formAttachments"
}
},
"formSubject": {
"__deferred": {
}
},
"formRouteMap": {
"__deferred": {
}
}
10/19/2022
}
}
Related Information
FormReviewFeedback
You can use this entity to get the request and response information about Ask for Feedback in Performance Management
forms.
Permissions
Query Query to get the request and response information about Ask for Feedback in a given form. FeedbackId is

Use Case 1: Query the Ask for Feedback Information

The following example shows how to query the request and response information about Ask for Feedback in a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormReviewFeedback(feedbackId=2L)?
$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormReviewFeedback(2L)",
"type": "SFOData.FormReviewFeedback"
},
10/19/2022
"feedbackId": "2",
"responseDate": "/Date(1497571200000)/",
"subjectUserEmail": null,
"pmFeedback": "feedback is udpated",
"requestUserEmail": null,
"appraiserUserEmail": "r.dong@sap.com",
"appraiserUserId": "<<Richard~r.dong@sap.com>>",
"responseId": "1",
"requestUserRole": "EM",
"digiCode": "3439c3e779d8600e4355f1eaf030f401",
"subjectUserId": null,
"companyId": "testLynn",
"requestDate": "/Date(1497868749700)/",
"formDataId": "87",
"requestUserId": "admin"
}
}
Use Case 2: Retrieve Ask for Feedback Information from FormReviewFeedbackList

The following example shows how to retrieve the request and response information about Ask for Feedback from the parent
entity FormReviewFeedbackList.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormReviewFeedbackList(formDataId=87L)?
$expand=formFeedbacks&$format=json
Response
{
"d": {
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormReviewFeedbackList(87L)",
"type": "SFOData.FormReviewFeedbackList"
},
"formDataId": "87",
"formFeedbacks": {
"results": [
{
"__metadata": {
"uri": "https://<api-server>/odata/v2/FormReviewFeedback(4L)",
},
"feedbackId": "4",
"responseDate": null,
"subjectUserEmail": null,
"pmFeedback": "",
"requestUserEmail": null,
10/19/2022
"appraiserUserEmail": "bbbqqq@sap.com",
"appraiserUserId": "<<Dong~bbbqqq@sap.com>>",
"responseId": "-1",
"requestUserRole": "EM",
"digiCode": "792b6252219ee0fad4dbee8266be5384",
"subjectUserId": null,
"companyId": "testLynn",
"requestDate": "/Date(1497868999386)/",
"formDataId": "87",
"requestUserId": "admin"
}
]
}
}
}
Error Codes
Error Code Description
400 - BAD_REQUEST FeedbackId cannot be null.
Related Information
FormReviewFeedbackList
You can use this entity to get a list of Ask for Feedback information in Performance Management forms.
Permissions
Query Query to get a list of Ask for Feedback information in a given form. FormDataId is required for the query
operation.

Use Case 1: Query a List of Ask for Feedback Information
10/19/2022
The following example shows how to query a list of Ask for Feedback information in a given form.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormReviewFeedbackList(formDataId=87L)?
$format=json
Response
{
"d": {
"__metadata": {
},
"formDataId": "87",
"formFeedbacks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormReviewFeedbackList(4L)/formFeedbacks"
}
}
}
}
Use Case 2: Retrieve a List of Ask for Feedback Information from FormHeader
The following example shows how to retrieve a list of Ask for Feedback information from the parent entity FormHeader.
Request
Operation Query
HTTP Method GET
URI http://<api-
server>/odata/v2/FormHeader(formDataId=87L)?
$expand=formFeedbackList&$format=json
Response
{
"d": {
"__metadata": {
},
"formDataId": "87",
"dateAssigned": "/Date(1505201897000+0000)/",
10/19/2022
"formOriginator": "admin",
"formSubjectId": "101147",
"sender": "101147",
"currentStep": "EM",
"stepDueDate": null,
"formTitle": "Impax-GDPR for Brian A Meta",
"rating": "0",
"isRated": false,
"formFeedbackList": {
"__metadata": {
},
"formDataId": "87",
"formFeedbacks": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormReviewFeedbackList(87L)/formFeedbacks
}
}
},
"formTemplate": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formTemplate"
}
},
"formLastContent": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formLastContent"
}
},
"formContents": {
"__deferred": {
}
},
"formSender": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formSender"
}
},
"formAttachments": {
"__deferred": {
"uri": "https://<api-server>/odata/v2/FormHeader(87L)/formAttachments"
}
},
"formSubject": {
"__deferred": {
10/19/2022
}
},
"formRouteMap": {
"__deferred": {
}
}
}
}
Error Codes
400 COE_GENERAL_BAD_REQUEST FormDataId cannot be null.
Related Information
Function Import
Function imports modify an entity. You use them as you would use any OData API.
The following function imports can be used to route the form:
signForm
sendToNextStep
rejectForm
All the above mentioned APIs return complex type object CORouteFormStatusBean.
Complex Type - CORouteFormStatusBean
status To return status of function import API. Value can be either Success
or Failure.
signForm
You can use this function import to sign Performance Management and 360 Reviews forms.
Permissions
10/19/2022
Query To sign a speci c form when the form is at the signature stage.
FormDataId is required for the query operation.
formDataId Indicates document ID. This is a mandatory eld.
comment Indicates the comment provided by the signer. This is an optional

eld. If Disable Ask For Comment Routing is selected in Form
Template Settings, this property is not allowed.
Use Case: Sign a Form

The following example shows how to use this function import to sign a form.
Request
Operation Query
HTTP Method GET
URI https://<hostname>/odata/v2/signForm?
formDataId=1234L &comment='my comment'
Response
<d:CORouteFormStatusBean xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="h

<d:status>Success</d:status>
</d:CORouteFormStatusBean>
Error Codes
TWF_MISS_REQUIRE_PARAMETER_ERROR FormDataId is not provided in the URL.
10/19/2022
TWF_INCORRECT_PARAMETER_ERROR You may get this error message due to the following reasons:
Form is not found for the given formDataId.
Form is found but the work ow action can't be operated. For

example, form is in the En Route or Completed folder.
Form is not at the signature stage.
Form doesn't reach the exit date based on route map

con guration.
The signer provides a comment when Disable Ask For

Comment Routing is selected in Form Template Settings.
sendToNextStep
You can use this function import to send Performance Management forms to the next step in route maps.
Permissions
Query To send a speci c form to the next step. FormDataId is required for
the query operation.
comment Indicates the comment provided by the user. This is an optional

innerStepUserId If the current step is the Iterative step, the property indicates a
recipient user in the current step. In this case, if the property isn’t
speci ed, it's assumed that the recipient user isn’t present and the
form is sent to the next step outside the Iterative step.
nextIStepEntryUser If the next step is the Iterative step, the property indicates the rst
recipient user in the next step.
Use Case 1: Send a Form to the Next Step

The following example shows how to use this function import to send a speci c form to the next step.
Request
10/19/2022
Operation Query
HTTP Method GET
URI https://<hostname>/odata/v2/sendToNextStep?
Response

Use Case 2: Send a Form to Another User in the Iterative Step

The following example shows how to send a speci c form to another user in the Iterative step.
Request
Operation Query
HTTP Method GET
formDataId=1234L &innerStepUserId='user1'
Response

Use Case 3: Send a Form to the Iterative Step

The following example shows how to send a speci c form to the next step that is the Iterative step.
Request
Operation Query
HTTP Method GET
formDataId=1234L &nextIStepEntryUser='user2'
Response

Error Codes
10/19/2022
TWF_MISS_REQUIRE_PARAMETER_ERROR The current step is the Iterative step and innerStepUserId hasn’t
been given.
Form isn’t found for the given formDataId.

Form isn’t at the modify or rejected stage.
The current step is the Iterative step and the innerStepId

value is same as the current user.
The user provides a comment when Disable Ask For

Related Information
sendToPreviousStep
You can use this function import to send Performance Management and 360 Reviews forms to the previous step at the modify
stage.
Permissions
Enable form routing to previous step is selected in Form Template Settings. For more information on permissions, see
Performance Management Form Entities.
Query To send a speci c form to the previous step. FormDataId is

comment Indicates the comment provided by the user. This is an optional

previousIStepEntryUser If the previous step is the Iterative step, the property indicates the
rst recipient user in the previous step.
Use Case: Send a Form to Previous Step

10/19/2022
The following example shows how to use this function import to send a speci c form to the previous step.
Request
Operation Query
HTTP Method GET
URI http://<Hostname>/odata/v2/sendToPreviousStep?
formDataId=192L &comment='test'
Response
{
"d": {
"CORouteFormStatusBean": {
"status": "Success"
}
}
}
Error Codes
COE_GENERAL_SERVER_FAILURE General server-side error message.
Based on form con guration, the form can't be sent to the

previous step at the current stage.
User has no permission to execute this action on the form

at the current step.
rejectForm
You can use this function import to reject Performance Management and 360 Reviews forms.
Permissions
Query To reject a speci c form when the form is at the signature stage.
FormDataId is required for the query operation.
10/19/2022
comment Indicates the comment for rejecting the form provided by the user.
This is an optional eld. If Disable Ask For Comment Routing is
selected in Form Template Settings, this property is not allowed.
Use Case: Reject a Form

The following example shows how to use this function import to reject a speci c form.
Request
Operation Query
HTTP Method GET
URI https://<hostname>/odata/v2/signForm?
Response

Error Codes
TWF_MISS_REQUIRE_PARAMETER_ERROR FormDataId is not provided in the URL.
Form is not found for the given formDataId.

Form is not at the signature stage.
Form doesn't reach the exit date based on route map

con guration.
The signer provides a comment when Disable Ask For

createPerformanceReviewForm
You can use this function import to launch Performance Management forms for single users. Before that, the start date, end
date, and due date of performance review should be con gured for the requested form template in Form Template Settings.
Permissions
10/19/2022
Only users who have permission to create forms are allowed to launch forms using this API. If they don't have permission to
create requested forms, the forms are not created and the API returns formDataId as -1. For more information on permissions,
see Performance Management Form Entities.
Query To create a Performance Management form for a speci c user at a

time. FormSubjectId and formTemplateId are required for the query
operation.
formSubjectId Subject user ID for whom the form is launched. This is a mandatory
eld.
formTemplateId ID of the selected form template. This is a mandatory eld.
sendEmail Default value for this eld is false. If the value is true, email
noti cation is sent to form subject.
enRouteCopy Default value for this eld is false. If the value is true, the copy of
the form is created in the En Route folder.
Use Case: Create a Performance Management Form

The following example shows how to use this function import to create a Performance Management form for a user.
Request
Operation Query
HTTP Method GET
URI http://<Hostname>/odata/v2/createPerformanceReviewForm?
formSubjectId='wsown1'& formTemplateId=391L&
sendEmail=true& enRouteCopy=false
Response
Successful Response:
<d:CreatePerformanceReviewFormResponse m:type="SFOData.CreatePerformanceReviewFormResponse" xmlns:d

<d:formDataId m:type="Edm.Int64">7894</d:formDataId>
<d:status>SUCCESS</d:status>
<d:statusCode m:type="Edm.Int64">200</d:statusCode>
</d:CreatePerformanceReviewFormResponse>
Failure Response:
10/19/2022
<d:CreatePerformanceReviewFormResponse m:type="SFOData.CreatePerformanceReviewFormResponse">
<d:formDataId m:type="Edm.Int64">-1</d:formDataId>
<d:status>FAILURE</d:status>
<d:statusCode m:type="Edm.Int64">500</d:statusCode>
</d:CreatePerformanceReviewFormResponse>
Error Codes
400 SC_BAD_REQUEST/Error code (400) indicates the following:
Requested form template is not a Performance

Management form template.
Form template is associated with an invalid rating scale.
Form template is not associated with a route map.
Overlapping forms exist for the given form template's

review period.
403 SC_FORBIDDEN/Status code (403) indicates that the logged-in

user doesn't have permission to launch forms using the requested
form template.
404 SC_NOT_FOUND/Status code (404) indicates that the

formTemplateId is invalid.
500 SC_INTERNAL_SERVER_ERROR/Status code (500) indicates that

an error inside the server prevents launching the form.
Related Information
SAP API Business Hub: Goal Plan

Performance Management APIs Guide PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Performance Management APIs Guide PDF

Uploaded by

Copyright:

Available Formats

10/19/2022

SAP SuccessFactors HXM Suite OData

SAP SuccessFactors Platform | 1H 2022

Original content: https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/28bc3c8e3f214ab487ec51b1b8709adc?

For more information, please visit the https://help.sap.com/docs/disclaimer.

Performance Management Form Entities

Query a list of form templates.

Query a list of user form folders.

Permission System Required Settings Note

Properties and Navigation Properties

1: The form is in the modify stage.

2: The form is in the rejected state.

3: The form is in the completed stage.

4: The form is deleted by the user or admins.

5: The form is in the signature stage.

Use Case: Query the Meta Information of a Form

HTTP Method GET

Query Query a list of form folders.

Properties and Navigation Properties

Use Case: Query Form Folders

HTTP Method GET

Properties and Navigation Properties

formContentId Form content ID. This is a business key.

formDataId Form data ID. This is a business key.

formSubjectId Form subject ID.

Use Case: Query Form Content

HTTP Method GET

Properties and Navigation Properties

Use Case 1: Query Diﬀerent Sections of a Form

HTTP Method GET

Use Case 2: Update a Competency Rating Comment

Query Query the basic information of form

Properties and Navigation Properties

Use Case: Query the Basic Information of Form Templates

HTTP Method GET

Query Query the basic information of competencies in a speci c form.

Properties and Navigation Properties

Use Case 1: Query the Basic Information of a Competency

Use Case 2: Update the Oﬃcial Rating of a Competency

Properties and Navigation Properties

Use Case 1: Query the Basic Information of a Competency Behavior

HTTP Method GET

Use Case 2: Update a Behavior Rating Comment

Properties and Navigation Properties

Use Case 1: Query the Basic Information of a Competency Section

HTTP Method GET

Use Case 2: Update the Rating Comment of a Competency Section

Upsert Update a speci c user’s rating and comment of a competency behavior.

Properties and Navigation Properties

Use Case 2: Update the Rating Comment of a Competency Behavior

Query Query the basic information of objectives in a speci c form.

Properties and Navigation Properties

Navigation Property Related Entity Description

comments FormObjectiveComment Navigation to the FormObjectiveComment

customElement FormCustomElement Navigation to the FormCustomElement

itemCon guration FormItemCon guration Navigation to the FormItemCon guration

objectiveDetails FormObjectiveDetails Navigation to the FormObjectiveDetails

oﬃcialRating FormUserRatingComment Navigation to the FormUserRatingComment

otherDetails FormObjectiveOtherDetails Navigation to the

othersRatingComment FormUserRatingComment Navigation to the FormUserRatingComment

Navigation Property Related Entity Description

selfRatingComment FormUserRatingComment Navigation to the FormUserRatingComment

metricLookupTables FormObjectiveDetails Currently, this navigation property is not