SAP SuccessFactors

Frends.SapSuccessFactors.Request / 1.1.0

Summary

Reaches SAP SuccessFactors over its OData and REST interfaces and returns the response in the format you ask for. A pass-through, so it covers the whole API surface.

Typical use — HR integrations such as employee and organisational data; being personal data, take only the fields the integration needs

Details

Frends version
5.7 and newer
Agent
Crossplatform
Target framework
net8.0

Essential parameters.

Name Type Default Example Description
UrlType UrlType Builder Builder

Choose how to construct the URL.

Possible values:

  • Builder: Build URL automatically from endpoint and parameters

  • Custom: Provide complete custom URL

RequestMethod RequestMethod GET GET

HTTP method for the request.

Possible values:

  • GET: GET method - retrieve data

  • POST: POST method - create new resource

  • PUT: PUT method - replace existing resource

  • PATCH: PATCH method - update existing resource

  • DELETE: DELETE method - remove resource

Endpoint String User

Entity name or endpoint path (Builder mode only).

QueryParameters String $filter=userId eq 'user123'&$select=userId,username

OData query parameters (Builder mode only)

CustomUrl String https://api.successfactors.com/odata/v2/User?$filter=status eq 'active'

Full custom URL (Custom mode only). Allows you to call ANY URL, including non-OData endpoints.

Body String {"userId": "user123", "username": "john.doe"}

Request body as JSON.

Headers Header[] [{ "Name": "X-Custom-Header", "Value": "CustomValue" }]

Additional HTTP headers (optional)

ResultFormat ReturnFormat JToken JToken

Format of the result to return

Possible values:

  • String: Return as string

  • JToken: Return as JSON token (JToken)

An unhandled error has occurred. Reload 🗙