2531388 - Getting started with OData API for PM and 360 Multi Rater forms

• How do I enable PM/360 OData API?
• Are there additional cost to enable PM/360 OData API?
• Where are the reference guides for PM/360 OData API?
• Are there any limitations on using PM/360 OData API?

• SAP SuccessFactors Performance Management
• SAP SuccessFactors 360 Multi Rater

How do I enable PM/360 OData API? 

1. The PM/360 OData API can be enabled through Permissions Systems. As long as you have the Admin access to OData API permissions, your API username can access its own folders and forms:

Permission System	Required Settings
Role based	Go to Admin Center -> Manage Permission Roles  -> Manage Integration Tools , and select Admin access to OData API
User based	Go to Admin Privilege -> Integration Tools , and select Admin access to OData API

 

2. If you wish to access other's forms and folders using your API username, you will need to enable Admin Access to Forms OData API:

Permission System	Required Settings
Role based	Go to Admin Center -> Manage Permission Roles ->  Manage Documents , and select Admin Access to Forms OData API.
User based	Go to Admin Privilege -> Manage Documents , and select Admin Access to Forms OData API

NOTE:

• If you are using Role based Permission (RBP), you can only access the folder and forms, whose owner is in your target population. The Admin Access to Forms OData API only provides read (query) access to other's form data, but you will not be able to edit, add, and delete other's form data.

3. If you want to fetch the deleted forms with entity FormHeader, you need to enable Include Deleted forms in Forms ODATA API:

Permission System	Required Settings
Role based	Go to Admin Center -> Manage Permission Roles ->  Manage Documents ->  Admin Access to Forms OData API, and 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.

More information on permissions issues can be found in the KBA 2485637.

4. If you want to query inactive user's forms, make sure the api executor is NOT granted permission "Restrict Data Access of Inactive Users' Forms".

If the executor user is granted the "Restrict Data Access of Inactive Users' Forms" permission, the user can not access inactive user's forms. So do not grant the permission if you want to query inactive user's forms.

5. If you want to query FormTemplate API, please make sure to have "Performance management access" included to API user role.

Are there additional cost to enable PM/360 OData API?

There are no additional cost to enable PM/360 OData API, as long as you have purchased a PM/360 usage license.

 

Where are the reference guides for PM/360 OData API?

You may find additional information for PM/360 OData API within the Talent section of SAP SuccessFactors HCM Suite OData API: Reference Guide. The guide provides examples on how to query and update different entities for PM/360 forms through OData API.

 

Are there any limitations on using PM/360 OData API?

Talent form OData APIs provide the ability to query and update forms that are created for Performance Management v12 Acceleration (or) 360 reviews. PMv11 forms and PMv12 forms (1.0) are currently not supported.

Additional Content: How to query performance rating via ODATA v2 API as an admin user

Please refer to this community blog on general how-to: Performance Management and API: How to query performance rating via ODATA v2 API as an admin user- SAP Community

Reference:

• 2485637 - "You do not have permission to access the form data" error when running OData APIs for PM or 360 - Performance Management
• 2686733 - How to retrieve deleted Performance Forms via SuccessFactors OData API - entity FormHeader
• Performance Management and API: How to query performance rating via ODATA v2 API as an admin user- SAP Community

PM, Performance Managmenet, PM OData API, Performance Management OData API, 360 OData API, 360 Forms, Frequently Asked Questions, inactive user form, query inactive user form, inactive user, inactive subject   , KBA , csg_q , LOD-SF-PM-API , Webservices, OData APIs , How To

SAP SuccessFactors HCM Suite all versions ; SAP SuccessFactors Performance & Goals all versions