Success Factors OData API

Help Article for Success Factors OData API Node

Revision History

1.0.1.1 Initial Release
1.0.1.2 Added the "Time Off" module to the samples.
1.0.1.3 Added the "Position Management" module to the samples.
1.0.1.4 Added the "Employment Information" module to the samples.
1.0.1.5 Added support for custom query string params.
1.0.1.7 Fixed bug that caused destructive actions on custom props.
1.0.2.0 Improved general error handling.
1.0.2.1 Improved error handling for token refresh.

Properties

Connection

Type: Connection Input
The Connection Property

SiteUrl
Type: String
Your Success Factors instance url including the OData endpoint. e.g.

https://api.sapsf.eu/odata/v2

CompanyId
Type: String
Used for authentication.

ClientId
Type: Password
Used for authentication.

SAMLToken
Type: Multiline Text
Used for authentication.

AccessToken
Type: Multiline Text
Used for authentication.

ReturnRestFailureResponses
Type: Boolean
When turned ON - Errors are not expressed as node errors, but are instead expressed inside the response payload.

ExcludeEmptyQueryParameters
Type: Boolean
When turned ON - Any empty custom properties on the node that would usually be expressed as query string parameters are ignored.

OperationId

Type: String Input
Contains the ID of the operation chosen from a Node Sample. This property shouldn't be manually changed.

Description

Type: String Input
A generated description of the operation based on what was available in the Swagger document.

Headers

Type: Multiline Text Input
Any custom-custom headers can be passed in to this property. Headers can be composed using the Formatter Node and should be formatted one per line with the notation header-name:header-value .

Request

Type: Multiline Text Input
Contains the request payload (usually JSON) that provides the detail of the operation to perform. A sample value for this property is populated when a Node Sample is selected.

ResponseCode

Type: Type: String Output
Contains the response code returned from the API Server. 200 = Success etc.

ResponseHeaders

Type: Multiline Text Output
Contains the response headers as received from the API Server.

Response

Type: Multiline Text Output
Contains the response payload (usually JSON) as received from the API. Where possible, a sample value of this property is populated when a Node Sample is selected.

Custom Inputs

This Node supports Custom Input Properties and the appropriate properties will be added to the Node when a Node Sample is selected. These Properties are resolved into parameters in the URL that is generated for the request. For example, if the operation will query a customer record, the Swagger document may specify the URL template as /customers/{customerId} . In this case, a Custom Property called customerId will be added to the Node when a "get customer" Node Sample is selected.

Remarks

The Success Factors OData API node authenticates through the OAuth 2.0 process. Using a SAML assertion token and other credentials generated by and placed in the connection by the user, a temporary access token is requested. Upon successful retrieval of an access token, the token is then used to authenticate any transactions on the API. The node can detect an expired access token and begin the journey of retrieving a new one.

Access tokens are placed back into the connection for use in other workflows using the same connection, it is not recommended that the AccessToken field is manually modified.