SAP Knowledge Base Article - Public

2900944 - Position Entity - OData API

Symptom

In this document we shall discuss the Position entity in the context of OData API.

You can use the Position entity to query position details, create, and edit positions. Included in this documentation is the fields contained in the entity, the Business/Required fields needed to create an upsert/query and an example API syntactical structure.

Environment

  • SuccessFactors
  • BizX
  • Integration Center

Resolution

Supported Operations

Query, Insert, Merge, Replace, Upsert, Delete

Properties

Property

Description

code

Business key

effectiveStartDate

Business key

businessUnit

The Business Unit in which this Job Posting belongs.

effectiveStatus

Effective status of the position. Possible values:

A: Active

I: Inactive

This field is required.

employeeClass

Employee class values can be found in MDF picklist EmployeeClass.

externalName_<locale>

A list of properties representing the external name of the position in different languages as indicated by the locale code.

externalName_defaultValue 

Default external name of the position.

location

The code of the location in which this Job Posting is located.

positionTitle

Position title. This field is required.

standardHours

The standard number of hours per week for this position

Use Case: Creating a Position with Insert

This example shows how to to create a position entry using insert.

Request

Operation

Insert

HTTP Method 

POST

URI

https://<API-Server>/odata/v2/Position

Headers

Accept: application/json

Content-Type: application/json

Payload

{
    "__metadata": {
        "uri": "Position"
    },
    "code": "11223344",
    "effectiveStartDate": "/Date(1574245948000)/",
    "positionTitle":"HR Administrator",
    "effectiveStatus":"A"
}

Response

{
    "d": {
        "__metadata": {
            "uri": "https://<API-Server>/odata/v2/Position(code='11223344',effectiveStartDate=datetime'2019-11-20T00:00:00')",
            "type": "SFOData.Position"
        },
        "positionTitle": "HR Administrator",
        "effectiveStatus": "A",
        "effectiveStartDate": "/Date(1574208000000)/",
        "code": "11223344"
    }
}

See Also

Standard documentation: SAP SuccessFactors Employee Central OData API: Reference Guide

Keywords

Position, OData API, Upsert, Query, positionTitle , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , Problem

Product

SAP SuccessFactors HXM Core all versions