SAP Knowledge Base Article - Public

2501909 - Succession Nomination History Odata API

Symptom

The NomineeHistory API pulls all changes for a successor nomination, per position, including: when a new nominee is added, when the readiness level changes, and when the approval status changes or the nomination comment is changed.

Environment

Permission System Required Settings
Role based Succession Planners > Succession Planning Permission

Back end: Web Services > SF Web Service Needs to be turned on in Provisioning Company Settings. (Please contact Customer Support to have this turned on, no additional fees involved)

Resolution

Additional Settings:

In addition to the Succession Planning Permissions, you also need to set the following option:  Admin Center > Org Chart Configuration > Succession org chart > Allow succession planners to view successors on org chart nodes/position tile view

Properties:

You can get detailed information about the entity properties from the OData API dictionary or by exposing the entity metadata. To do this, use the following query https://<hostname>/odata/v2/Entity('<Your Entity')?$format=json


Request Information:

Operation Query
URI http://<Hostname>/odata/v2/Position?$select=successorNav/nomineeHistoryNav&$expand=successorNav/nomineeHistoryNav&$filter=successorNav/id%20ne%20null&$format=json
Headers Authorization: Basic <Base 64 encoded (“user@company:password”)>

auth.jpg

Response (Sample Code):

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://localhost:443/odata/v2/Position(code='229',effectiveStartDate=datetime'2016-02-16T00:00:00')",
          "type": "SFOData.Position"
        },
        "successorNav": {
          "results": [
            {
              "__metadata": {
                "uri": "https://localhost:443/odata/v2/Successor(591L)",
                "type": "SFOData.Successor"
              },
              "nomineeHistoryNav": {
                "results": [
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(361L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "361",
                    "changeType": 0,
                    "rank": 3,
                    "nomineeId": "591",
                    "status": 1,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "1",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1456435849000)/",
                    "nomineeUserId": "hwilson1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(361L)/userNav"
                      }
                    }
                  }
                ]
              }
            },
            {
              "__metadata": {
                "uri": "https://localhost:443/odata/v2/Successor(592L)",
                "type": "SFOData.Successor"
              },
              "nomineeHistoryNav": {
                "results": [
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(365L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "365",
                    "changeType": 0,
                    "rank": 5,
                    "nomineeId": "592",
                    "status": 1,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "2",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1456782286000)/",
                    "nomineeUserId": "jreed1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(365L)/userNav"
                      }
                    }
                  },
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(366L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "366",
                    "changeType": 2,
                    "rank": 5,
                    "nomineeId": "592",
                    "status": 1,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "1",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1456782296000)/",
                    "nomineeUserId": "jreed1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(366L)/userNav"
                      }
                    }
                  },
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(367L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "367",
                    "changeType": 3,
                    "rank": 3,
                    "nomineeId": "592",
                    "status": 1,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "1",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1456782296000)/",
                    "nomineeUserId": "jreed1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(367L)/userNav"
                      }
                    }
                  },
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(373L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "373",
                    "changeType": 0,
                    "rank": 5,
                    "nomineeId": "592",
                    "status": 1,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "2",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1457307323000)/",
                    "nomineeUserId": "jreed1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(373L)/userNav"
                      }
                    }
                  },
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(374L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "374",
                    "changeType": 4,
                    "rank": 5,
                    "nomineeId": "592",
                    "status": 3,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "2",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1457307328000)/",
                    "nomineeUserId": "jreed1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(374L)/userNav"
                      }
                    }
                  },
                  {
                    "__metadata": {
                      "uri": "https://localhost:443/odata/v2/NomineeHistory(368L)",
                      "type": "SFOData.NomineeHistory"
                    },
                    "id": "368",
                    "changeType": 4,
                    "rank": 3,
                    "nomineeId": "592",
                    "status": 3,
                    "modifiedBy": "admin",
                    "proxyUserId": null,
                    "readiness": "1",
                    "note": null,
                    "nominationId": "340",
                    "modifiedDate": "/Date(1456782328000)/",
                    "nomineeUserId": "jreed1",
                    "userNav": {
                      "__deferred": {
                        "uri": "https://localhost:443/odata/v2/NomineeHistory(368L)/userNav"
                      }
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }

See Also

2248199 - How to execute an Odata API Query on the web browser?

Keywords

Nomination History, Odata, API , KBA , LOD-SF-SCM-API , Webservices & API's , LOD-SF-SCM-NOM , Nominations - Form Based and Formless , How To

Product

SAP SuccessFactors HCM Core 1705