Note: There is a newer version (1.1.1) of this package available. Click here to view docs for the latest version.

Module sap.successfactors.ecpersonalinformation

ballerinax/sap.successfactors.ecpersonalinformation Ballerina library

1.0.0

Overview

SAP SuccessFactors Employee Central is a comprehensive human capital management solution that helps organizations manage their workforce effectively. It provides a unified platform for HR processes including employee data management, organizational structures, and employment lifecycle management.

The ballerinax/sap.successfactors.ecpersonalinformation package provides APIs to interact with the SAP SuccessFactors Employee Central Personal Information API.

Key Features

Manage employee personal information including biographical data
Access addresses, contacts, national IDs, and social accounts
Query emergency contacts and personal details
Support for basic and OAuth 2.0 authentication

Setup guide

Sign in to your SAP SuccessFactors instance as an administrator.
Navigate to Admin Center > Manage OAuth2 Client Applications and register a new OAuth2 client application for your integration.
Note down the API Key (client ID) and configure the appropriate scopes for the Employee Central APIs you intend to use.
Locate your Company ID and the API server hostname for your SuccessFactors region. You can find the list of API servers in the SAP SuccessFactors API documentation.
Use Basic Authentication (username + password) or OAuth 2.0 SAML Bearer to authenticate with the API.

Quickstart

To use the sap.successfactors.ecpersonalinformation connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the sap.successfactors.ecpersonalinformation module.


import ballerinax/sap.successfactors.ecpersonalinformation as personalinformation;

Step 2: Instantiate a new connector

Use the hostname and credentials to initiate a client.


configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

personalinformation:Client personalinformationClient = check new (
    {
      auth: {
        username,
        password
      }
    },
    hostname
);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.


personalinformation:PerPersonWrapper result = check personalinformationClient->listPerPersons();

Step 4: Run the Ballerina application


bal run

Examples

The SAP SuccessFactors Employee Central Ballerina connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like syncing employee data and sending notifications.

Google Sheets to SuccessFactors - Read employee records from a Google Sheets roster and create Personal Information records in SuccessFactors.
SuccessFactors to Slack - Poll SuccessFactors for newly onboarded employees and send welcome notifications to a Slack channel.

Clients

sap.successfactors.ecpersonalinformation: Client

Isolated

You can use these APIs to access the personal information of an employee including emergency contact information, social media accounts, email address, and non-effective-dated biographical information such as date of birth, country of birth and national identification card information.

You can find your company's API server in List of API Servers in SAP SuccessFactors.

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string hostname, int port)

config ConnectionConfig - The configurations to be used when initializing the connector

hostname string -

port int 443 -

listPerEmergencyContactss

Isolated FunctionRemote Function

function listPerEmergencyContactss(map<string|string[]> headers, *ListPerEmergencyContactssQueries queries) returns Wrapper|error

Get entities from PerEmergencyContacts

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerEmergencyContactssQueries - Queries to be sent with the request

Return Type

Wrapper|error - Retrieved entities

getPerEmergencyContacts

Isolated FunctionRemote Function

function getPerEmergencyContacts(string name, string personIdExternal, string relationship, map<string|string[]> headers, *GetPerEmergencyContactsQueries queries) returns PerEmergencyContacts|error

Get entity from PerEmergencyContacts by key

Parameters

name string - key: name

personIdExternal string - key: personIdExternal

relationship string - key: relationship

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerEmergencyContactsQueries - Queries to be sent with the request

Return Type

PerEmergencyContacts|error - Retrieved entity

listPerPhones

Isolated FunctionRemote Function

function listPerPhones(map<string|string[]> headers, *ListPerPhonesQueries queries) returns Wrapper_1|error

Get entities from PerPhone

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerPhonesQueries - Queries to be sent with the request

Return Type

Wrapper_1|error - Retrieved entities

getPerPhone

Isolated FunctionRemote Function

function getPerPhone(string personIdExternal, string phoneType, map<string|string[]> headers, *GetPerPhoneQueries queries) returns PerPhone|error

Get entity from PerPhone by key

Parameters

personIdExternal string - key: personIdExternal

phoneType string - key: phoneType

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerPhoneQueries - Queries to be sent with the request

Return Type

PerPhone|error - Retrieved entity

listPersonKeys

Isolated FunctionRemote Function

function listPersonKeys(map<string|string[]> headers, *ListPersonKeysQueries queries) returns Wrapper_2|error

Get entities from PersonKey

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPersonKeysQueries - Queries to be sent with the request

Return Type

Wrapper_2|error - Retrieved entities

getPersonKey

Isolated FunctionRemote Function

function getPersonKey(string personIdExternal, map<string|string[]> headers, *GetPersonKeyQueries queries) returns PersonKey|error

Get entity from PersonKey by key

Parameters

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPersonKeyQueries - Queries to be sent with the request

Return Type

PersonKey|error - Retrieved entity

listPerPersonals

Isolated FunctionRemote Function

function listPerPersonals(map<string|string[]> headers, *ListPerPersonalsQueries queries) returns Wrapper_3|error

Get entities from PerPersonal

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerPersonalsQueries - Queries to be sent with the request

Return Type

Wrapper_3|error - Retrieved entities

getPerPersonal

Isolated FunctionRemote Function

function getPerPersonal(string personIdExternal, string startDate, map<string|string[]> headers, *GetPerPersonalQueries queries) returns PerPersonal|error

Get entity from PerPersonal by key

Parameters

personIdExternal string - key: personIdExternal

startDate string - key: startDate

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerPersonalQueries - Queries to be sent with the request

Return Type

PerPersonal|error - Retrieved entity

listPerSocialAccounts

Isolated FunctionRemote Function

function listPerSocialAccounts(map<string|string[]> headers, *ListPerSocialAccountsQueries queries) returns Wrapper_4|error

Get entities from PerSocialAccount

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerSocialAccountsQueries - Queries to be sent with the request

Return Type

Wrapper_4|error - Retrieved entities

getPerSocialAccount

Isolated FunctionRemote Function

function getPerSocialAccount(string domain, string personIdExternal, map<string|string[]> headers, *GetPerSocialAccountQueries queries) returns PerSocialAccount|error

Get entity from PerSocialAccount by key

Parameters

domain string - key: domain

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerSocialAccountQueries - Queries to be sent with the request

Return Type

PerSocialAccount|error - Retrieved entity

listPerPersons

Isolated FunctionRemote Function

function listPerPersons(map<string|string[]> headers, *ListPerPersonsQueries queries) returns Wrapper_5|error

Get entities from PerPerson

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerPersonsQueries - Queries to be sent with the request

Return Type

Wrapper_5|error - Retrieved entities

getPerPerson

Isolated FunctionRemote Function

function getPerPerson(string personIdExternal, map<string|string[]> headers, *GetPerPersonQueries queries) returns PerPerson|error

Get entity from PerPerson by key

Parameters

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerPersonQueries - Queries to be sent with the request

Return Type

PerPerson|error - Retrieved entity

listPerPersonRelationships

Isolated FunctionRemote Function

function listPerPersonRelationships(map<string|string[]> headers, *ListPerPersonRelationshipsQueries queries) returns Wrapper_6|error

Get entities from PerPersonRelationship

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerPersonRelationshipsQueries - Queries to be sent with the request

Return Type

Wrapper_6|error - Retrieved entities

getPerPersonRelationship

Isolated FunctionRemote Function

function getPerPersonRelationship(string personIdExternal, string relatedPersonIdExternal, string startDate, map<string|string[]> headers, *GetPerPersonRelationshipQueries queries) returns PerPersonRelationship|error

Get entity from PerPersonRelationship by key

Parameters

personIdExternal string - key: personIdExternal

relatedPersonIdExternal string - key: relatedPersonIdExternal

startDate string - key: startDate

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerPersonRelationshipQueries - Queries to be sent with the request

Return Type

PerPersonRelationship|error - Retrieved entity

listPerEmails

Isolated FunctionRemote Function

function listPerEmails(map<string|string[]> headers, *ListPerEmailsQueries queries) returns Wrapper_7|error

Get entities from PerEmail

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerEmailsQueries - Queries to be sent with the request

Return Type

Wrapper_7|error - Retrieved entities

getPerEmail

Isolated FunctionRemote Function

function getPerEmail(string emailType, string personIdExternal, map<string|string[]> headers, *GetPerEmailQueries queries) returns PerEmail|error

Get entity from PerEmail by key

Parameters

emailType string - key: emailType

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerEmailQueries - Queries to be sent with the request

Return Type

PerEmail|error - Retrieved entity

listHrisEmergencyContactAddressDEFLTs

Isolated FunctionRemote Function

function listHrisEmergencyContactAddressDEFLTs(map<string|string[]> headers, *ListHrisEmergencyContactAddressDEFLTsQueries queries) returns Wrapper_8|error

Get entities from HrisEmergencyContactAddressDEFLT

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListHrisEmergencyContactAddressDEFLTsQueries - Queries to be sent with the request

Return Type

Wrapper_8|error - Retrieved entities

getHrisEmergencyContactAddressDEFLT

Isolated FunctionRemote Function

function getHrisEmergencyContactAddressDEFLT(string addressId, map<string|string[]> headers, *GetHrisEmergencyContactAddressDEFLTQueries queries) returns HrisEmergencyContactAddressDEFLT|error

Get entity from HrisEmergencyContactAddressDEFLT by key

Parameters

addressId string - key: addressId

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetHrisEmergencyContactAddressDEFLTQueries - Queries to be sent with the request

Return Type

HrisEmergencyContactAddressDEFLT|error - Retrieved entity

listPerNationalIds

Isolated FunctionRemote Function

function listPerNationalIds(map<string|string[]> headers, *ListPerNationalIdsQueries queries) returns Wrapper_9|error

Get entities from PerNationalId

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerNationalIdsQueries - Queries to be sent with the request

Return Type

Wrapper_9|error - Retrieved entities

getPerNationalId

Isolated FunctionRemote Function

function getPerNationalId(string cardType, string country, string personIdExternal, map<string|string[]> headers, *GetPerNationalIdQueries queries) returns PerNationalId|error

Get entity from PerNationalId by key

Parameters

cardType string - key: cardType

country string - key: country

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerNationalIdQueries - Queries to be sent with the request

Return Type

PerNationalId|error - Retrieved entity

listPerNationalIdWithValidityPeriods

Isolated FunctionRemote Function

function listPerNationalIdWithValidityPeriods(map<string|string[]> headers, *ListPerNationalIdWithValidityPeriodsQueries queries) returns Wrapper_10|error

Get entities from PerNationalIdWithValidityPeriod

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerNationalIdWithValidityPeriodsQueries - Queries to be sent with the request

Return Type

Wrapper_10|error - Retrieved entities

getPerNationalIdWithValidityPeriod

Isolated FunctionRemote Function

function getPerNationalIdWithValidityPeriod(string recordId, string personIdExternal, map<string|string[]> headers, *GetPerNationalIdWithValidityPeriodQueries queries) returns PerNationalIdWithValidityPeriod|error

Get entity from PerNationalIdWithValidityPeriod by key

Parameters

recordId string - key: recordId

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerNationalIdWithValidityPeriodQueries - Queries to be sent with the request

Return Type

PerNationalIdWithValidityPeriod|error - Retrieved entity

listPerAddressDEFLTs

Isolated FunctionRemote Function

function listPerAddressDEFLTs(map<string|string[]> headers, *ListPerAddressDEFLTsQueries queries) returns Wrapper_11|error

Get entities from PerAddressDEFLT

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerAddressDEFLTsQueries - Queries to be sent with the request

Return Type

Wrapper_11|error - Retrieved entities

getPerAddressDEFLT

Isolated FunctionRemote Function

function getPerAddressDEFLT(string addressType, string personIdExternal, string startDate, map<string|string[]> headers, *GetPerAddressDEFLTQueries queries) returns PerAddressDEFLT|error

Get entity from PerAddressDEFLT by key

Parameters

addressType string - key: addressType

personIdExternal string - key: personIdExternal

startDate string - key: startDate

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerAddressDEFLTQueries - Queries to be sent with the request

Return Type

PerAddressDEFLT|error - Retrieved entity

creategenerateNextPersonID

Isolated FunctionRemote Function

function creategenerateNextPersonID(map<string|string[]> headers) returns Result|error

Invoke action generateNextPersonID

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Result|error - Success

listNameFormatGOs

Isolated FunctionRemote Function

function listNameFormatGOs(map<string|string[]> headers, *ListNameFormatGOsQueries queries) returns Wrapper_12|error

Get entities from NameFormatGO

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListNameFormatGOsQueries - Queries to be sent with the request

Return Type

Wrapper_12|error - Retrieved entities

getNameFormatGO

Isolated FunctionRemote Function

function getNameFormatGO(string externalCode, map<string|string[]> headers, *GetNameFormatGOQueries queries) returns NameFormatGO|error

Get entity from NameFormatGO by key

Parameters

externalCode string - key: externalCode

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetNameFormatGOQueries - Queries to be sent with the request

Return Type

NameFormatGO|error - Retrieved entity

listNameElementGOs

Isolated FunctionRemote Function

function listNameElementGOs(map<string|string[]> headers, *ListNameElementGOsQueries queries) returns Wrapper_13|error

Get entities from NameElementGO

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListNameElementGOsQueries - Queries to be sent with the request

Return Type

Wrapper_13|error - Retrieved entities

getNameElementGO

Isolated FunctionRemote Function

function getNameElementGO(string NameFormatGO_externalCode, string externalCode, map<string|string[]> headers, *GetNameElementGOQueries queries) returns NameElementGO|error

Get entity from NameElementGO by key

Parameters

NameFormatGO_externalCode string - key: NameFormatGO_externalCode

externalCode string - key: externalCode

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetNameElementGOQueries - Queries to be sent with the request

Return Type

NameElementGO|error - Retrieved entity

listPerBiographicalInfoLocBRAs

Isolated FunctionRemote Function

function listPerBiographicalInfoLocBRAs(map<string|string[]> headers, *ListPerBiographicalInfoLocBRAsQueries queries) returns Wrapper_14|error

Get entities from PerBiographicalInfoLocBRA

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerBiographicalInfoLocBRAsQueries - Queries to be sent with the request

Return Type

Wrapper_14|error - Retrieved entities

getPerBiographicalInfoLocBRA

Isolated FunctionRemote Function

function getPerBiographicalInfoLocBRA(string country, string personIdExternal, map<string|string[]> headers, *GetPerBiographicalInfoLocBRAQueries queries) returns PerBiographicalInfoLocBRA|error

Get entity from PerBiographicalInfoLocBRA by key

Parameters

country string - key: country

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerBiographicalInfoLocBRAQueries - Queries to be sent with the request

Return Type

PerBiographicalInfoLocBRA|error - Retrieved entity

listPerBiographicalInfoLocCHLs

Isolated FunctionRemote Function

function listPerBiographicalInfoLocCHLs(map<string|string[]> headers, *ListPerBiographicalInfoLocCHLsQueries queries) returns Wrapper_15|error

Get entities from PerBiographicalInfoLocCHL

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerBiographicalInfoLocCHLsQueries - Queries to be sent with the request

Return Type

Wrapper_15|error - Retrieved entities

getPerBiographicalInfoLocCHL

Isolated FunctionRemote Function

function getPerBiographicalInfoLocCHL(string country, string personIdExternal, map<string|string[]> headers, *GetPerBiographicalInfoLocCHLQueries queries) returns PerBiographicalInfoLocCHL|error

Get entity from PerBiographicalInfoLocCHL by key

Parameters

country string - key: country

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerBiographicalInfoLocCHLQueries - Queries to be sent with the request

Return Type

PerBiographicalInfoLocCHL|error - Retrieved entity

listPerBiographicalInfoLocFRAs

Isolated FunctionRemote Function

function listPerBiographicalInfoLocFRAs(map<string|string[]> headers, *ListPerBiographicalInfoLocFRAsQueries queries) returns Wrapper_16|error

Get entities from PerBiographicalInfoLocFRA

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerBiographicalInfoLocFRAsQueries - Queries to be sent with the request

Return Type

Wrapper_16|error - Retrieved entities

getPerBiographicalInfoLocFRA

Isolated FunctionRemote Function

function getPerBiographicalInfoLocFRA(string country, string personIdExternal, map<string|string[]> headers, *GetPerBiographicalInfoLocFRAQueries queries) returns PerBiographicalInfoLocFRA|error

Get entity from PerBiographicalInfoLocFRA by key

Parameters

country string - key: country

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerBiographicalInfoLocFRAQueries - Queries to be sent with the request

Return Type

PerBiographicalInfoLocFRA|error - Retrieved entity

listPerBiographicalInfoLocITAs

Isolated FunctionRemote Function

function listPerBiographicalInfoLocITAs(map<string|string[]> headers, *ListPerBiographicalInfoLocITAsQueries queries) returns Wrapper_17|error

Get entities from PerBiographicalInfoLocITA

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerBiographicalInfoLocITAsQueries - Queries to be sent with the request

Return Type

Wrapper_17|error - Retrieved entities

getPerBiographicalInfoLocITA

Isolated FunctionRemote Function

function getPerBiographicalInfoLocITA(string country, string personIdExternal, map<string|string[]> headers, *GetPerBiographicalInfoLocITAQueries queries) returns PerBiographicalInfoLocITA|error

Get entity from PerBiographicalInfoLocITA by key

Parameters

country string - key: country

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerBiographicalInfoLocITAQueries - Queries to be sent with the request

Return Type

PerBiographicalInfoLocITA|error - Retrieved entity

listPerBiographicalInfoLocVENs

Isolated FunctionRemote Function

function listPerBiographicalInfoLocVENs(map<string|string[]> headers, *ListPerBiographicalInfoLocVENsQueries queries) returns Wrapper_18|error

Get entities from PerBiographicalInfoLocVEN

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListPerBiographicalInfoLocVENsQueries - Queries to be sent with the request

Return Type

Wrapper_18|error - Retrieved entities

getPerBiographicalInfoLocVEN

Isolated FunctionRemote Function

function getPerBiographicalInfoLocVEN(string country, string personIdExternal, map<string|string[]> headers, *GetPerBiographicalInfoLocVENQueries queries) returns PerBiographicalInfoLocVEN|error

Get entity from PerBiographicalInfoLocVEN by key

Parameters

country string - key: country

personIdExternal string - key: personIdExternal

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPerBiographicalInfoLocVENQueries - Queries to be sent with the request

Return Type

PerBiographicalInfoLocVEN|error - Retrieved entity

Records

sap.successfactors.ecpersonalinformation: CollectionofHrisEmergencyContactAddressDEFLT

Fields

results? HrisEmergencyContactAddressDEFLT[] -

sap.successfactors.ecpersonalinformation: CollectionofNameElementGO

Fields

results? NameElementGO[] -

sap.successfactors.ecpersonalinformation: CollectionofNameFormatGO

Fields

results? NameFormatGO[] -

sap.successfactors.ecpersonalinformation: CollectionofPerAddressDEFLT

Fields

results? PerAddressDEFLT[] -

sap.successfactors.ecpersonalinformation: CollectionofPerBiographicalInfoLocBRA

Fields

results? PerBiographicalInfoLocBRA[] -

sap.successfactors.ecpersonalinformation: CollectionofPerBiographicalInfoLocCHL

Fields

results? PerBiographicalInfoLocCHL[] -

sap.successfactors.ecpersonalinformation: CollectionofPerBiographicalInfoLocFRA

Fields

results? PerBiographicalInfoLocFRA[] -

sap.successfactors.ecpersonalinformation: CollectionofPerBiographicalInfoLocITA

Fields

results? PerBiographicalInfoLocITA[] -

sap.successfactors.ecpersonalinformation: CollectionofPerBiographicalInfoLocVEN

Fields

results? PerBiographicalInfoLocVEN[] -

sap.successfactors.ecpersonalinformation: CollectionofPerEmail

Fields

results? PerEmail[] -

sap.successfactors.ecpersonalinformation: CollectionofPerEmergencyContacts

Fields

results? PerEmergencyContacts[] -

sap.successfactors.ecpersonalinformation: CollectionofPerNationalId

Fields

results? PerNationalId[] -

sap.successfactors.ecpersonalinformation: CollectionofPerNationalIdWithValidityPeriod

Fields

results? PerNationalIdWithValidityPeriod[] -

sap.successfactors.ecpersonalinformation: CollectionofPerPerson

Fields

results? PerPerson[] -

sap.successfactors.ecpersonalinformation: CollectionofPerPersonal

Fields

results? PerPersonal[] -

sap.successfactors.ecpersonalinformation: CollectionofPerPersonRelationship

Fields

results? PerPersonRelationship[] -

sap.successfactors.ecpersonalinformation: CollectionofPerPhone

Fields

results? PerPhone[] -

sap.successfactors.ecpersonalinformation: CollectionofPerSocialAccount

Fields

results? PerSocialAccount[] -

sap.successfactors.ecpersonalinformation: CollectionofPersonKey

Fields

results? PersonKey[] -

sap.successfactors.ecpersonalinformation: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth CredentialsConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

sap.successfactors.ecpersonalinformation: GenerateNextPersonIDResponse

sap.successfactors.ecpersonalinformation: GetHrisEmergencyContactAddressDEFLTQueries

Represents the Queries record for the operation: getHrisEmergencyContactAddressDEFLT

Fields

\$select? ("address1"|"address2"|"address3"|"address4"|"address5"|"addressId"|"addressType"|"city"|"country"|"county"|"createdBy"|"createdDateTime"|"createdOn"|"endDate"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"notes"|"province"|"startDate"|"state"|"zipCode")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetNameElementGOQueries

Represents the Queries record for the operation: getNameElementGO

Fields

\$select? ("NameFormatGO_externalCode"|"createdBy"|"createdDate"|"createdDateTime"|"externalCode"|"lastModifiedBy"|"lastModifiedDate"|"lastModifiedDateTime"|"lastModifiedDateWithTZ"|"mdfSystemEffectiveEndDate"|"mdfSystemEffectiveStartDate"|"mdfSystemEntityId"|"mdfSystemObjectType"|"mdfSystemRecordId"|"mdfSystemRecordStatus"|"mdfSystemStatus"|"mdfSystemTransactionSequence"|"mdfSystemVersionId"|"nameArtifactEnum"|"sampleData"|"separator")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetNameFormatGOQueries

Represents the Queries record for the operation: getNameFormatGO

Fields

\$expand? ("*"|"nameElements")[] - Expand related entities, see OData Expand

\$select? ("createdBy"|"createdDateTime"|"externalCode"|"externalName"|"lastModifiedBy"|"lastModifiedDateTime"|"mdfSystemCreatedBy"|"mdfSystemCreatedDate"|"mdfSystemEffectiveEndDate"|"mdfSystemEffectiveStartDate"|"mdfSystemEntityId"|"mdfSystemLastModifiedBy"|"mdfSystemLastModifiedDate"|"mdfSystemLastModifiedDateWithTZ"|"mdfSystemObjectType"|"mdfSystemRecordId"|"mdfSystemRecordStatus"|"mdfSystemStatus"|"mdfSystemTransactionSequence"|"mdfSystemVersionId"|"sample")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerAddressDEFLTQueries

Represents the Queries record for the operation: getPerAddressDEFLT

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("address1"|"address2"|"address3"|"address4"|"address5"|"addressType"|"city"|"country"|"county"|"createdBy"|"createdDateTime"|"createdOn"|"empUsersSysId"|"endDate"|"includeAllRecords"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"notes"|"operation"|"personIdExternal"|"province"|"startDate"|"state"|"zipCode")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerBiographicalInfoLocBRAQueries

Represents the Queries record for the operation: getPerBiographicalInfoLocBRA

Fields

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerBiographicalInfoLocCHLQueries

Represents the Queries record for the operation: getPerBiographicalInfoLocCHL

Fields

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerBiographicalInfoLocFRAQueries

Represents the Queries record for the operation: getPerBiographicalInfoLocFRA

Fields

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerBiographicalInfoLocITAQueries

Represents the Queries record for the operation: getPerBiographicalInfoLocITA

Fields

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerBiographicalInfoLocVENQueries

Represents the Queries record for the operation: getPerBiographicalInfoLocVEN

Fields

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerEmailQueries

Represents the Queries record for the operation: getPerEmail

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("createdBy"|"createdDateTime"|"createdOn"|"emailAddress"|"emailType"|"includeAllRecords"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerEmergencyContactsQueries

Represents the Queries record for the operation: getPerEmergencyContacts

Fields

\$expand? ("*"|"addressNavDEFLT"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("addressAddress1"|"addressAddress2"|"addressAddress3"|"addressCity"|"addressCountry"|"addressCounty"|"addressProvince"|"addressState"|"addressZipCode"|"createdBy"|"createdDateTime"|"createdOn"|"email"|"isAddSameAsEmployee"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"name"|"operation"|"personIdExternal"|"phone"|"primaryFlag"|"relationship"|"secondPhone")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerNationalIdQueries

Represents the Queries record for the operation: getPerNationalId

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("cardType"|"country"|"createdBy"|"createdDateTime"|"createdOn"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"nationalId"|"notes"|"operation"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerNationalIdWithValidityPeriodQueries

Represents the Queries record for the operation: getPerNationalIdWithValidityPeriod

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("cardType"|"country"|"createdBy"|"createdDateTime"|"createdOn"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"nationalId"|"notes"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerPersonalQueries

Represents the Queries record for the operation: getPerPersonal

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("attachmentId"|"businessFirstName"|"businessLastName"|"createdBy"|"createdDateTime"|"createdOn"|"displayName"|"endDate"|"firstName"|"gender"|"includeAllRecords"|"initials"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"lastName"|"maritalStatus"|"middleName"|"nationality"|"nativePreferredLang"|"operation"|"personIdExternal"|"preferredName"|"salutation"|"script"|"startDate"|"title")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerPersonQueries

Represents the Queries record for the operation: getPerPerson

Fields

\$expand? ("*"|"emailNav"|"emergencyContactNav"|"homeAddressNavDEFLT"|"nationalIdNav"|"personRerlationshipNav"|"personalInfoNav"|"phoneNav"|"socialAccountNav")[] - Expand related entities, see OData Expand

\$select? ("birthName"|"countryOfBirth"|"createdBy"|"createdDateTime"|"createdOn"|"dateOfBirth"|"includeAllRecords"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"perPersonUuid"|"personId"|"personIdExternal"|"regionOfBirth"|"userId")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerPersonRelationshipQueries

Represents the Queries record for the operation: getPerPersonRelationship

Fields

\$expand? ("*"|"personNav"|"relNationalIdNav"|"relPersonNav"|"relPersonalNav")[] - Expand related entities, see OData Expand

\$select? ("addressAddress1"|"addressAddress2"|"addressAddress3"|"addressCity"|"addressCountry"|"addressCounty"|"addressProvince"|"addressState"|"addressZipCode"|"attachmentId"|"createdBy"|"createdDateTime"|"createdOn"|"endDate"|"firstName"|"isAccompanyingDependent"|"isAddressSameAsPerson"|"isBeneficiary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"lastName"|"operation"|"personIdExternal"|"relatedPersonIdExternal"|"relationshipType"|"startDate")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerPhoneQueries

Represents the Queries record for the operation: getPerPhone

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("areaCode"|"countryCode"|"createdBy"|"createdDateTime"|"createdOn"|"extension"|"includeAllRecords"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"phoneNumber"|"phoneType")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPerSocialAccountQueries

Represents the Queries record for the operation: getPerSocialAccount

Fields

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$select? ("createdBy"|"createdDateTime"|"createdOn"|"domain"|"imId"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"url")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: GetPersonKeyQueries

Represents the Queries record for the operation: getPersonKey

Fields

\$select? ("perPersonUuid"|"personId"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: HrisEmergencyContactAddressDEFLT

Fields

d? HrisEmergencyContactAddressDEFLT -

sap.successfactors.ecpersonalinformation: ListHrisEmergencyContactAddressDEFLTsQueries

Represents the Queries record for the operation: listHrisEmergencyContactAddressDEFLTs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("address1"|"address1 desc"|"address2"|"address2 desc"|"address3"|"address3 desc"|"address4"|"address4 desc"|"address5"|"address5 desc"|"addressId"|"addressId desc"|"addressType"|"addressType desc"|"city"|"city desc"|"country"|"country desc"|"county"|"county desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"endDate"|"endDate desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"notes"|"notes desc"|"province"|"province desc"|"startDate"|"startDate desc"|"state"|"state desc"|"zipCode"|"zipCode desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("address1"|"address2"|"address3"|"address4"|"address5"|"addressId"|"addressType"|"city"|"country"|"county"|"createdBy"|"createdDateTime"|"createdOn"|"endDate"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"notes"|"province"|"startDate"|"state"|"zipCode")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListNameElementGOsQueries

Represents the Queries record for the operation: listNameElementGOs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("NameFormatGO_externalCode"|"NameFormatGO_externalCode desc"|"createdBy"|"createdBy desc"|"createdDate"|"createdDate desc"|"createdDateTime"|"createdDateTime desc"|"externalCode"|"externalCode desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDate"|"lastModifiedDate desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedDateWithTZ"|"lastModifiedDateWithTZ desc"|"mdfSystemEffectiveEndDate"|"mdfSystemEffectiveEndDate desc"|"mdfSystemEffectiveStartDate"|"mdfSystemEffectiveStartDate desc"|"mdfSystemEntityId"|"mdfSystemEntityId desc"|"mdfSystemObjectType"|"mdfSystemObjectType desc"|"mdfSystemRecordId"|"mdfSystemRecordId desc"|"mdfSystemRecordStatus"|"mdfSystemRecordStatus desc"|"mdfSystemStatus"|"mdfSystemStatus desc"|"mdfSystemTransactionSequence"|"mdfSystemTransactionSequence desc"|"mdfSystemVersionId"|"mdfSystemVersionId desc"|"nameArtifactEnum"|"nameArtifactEnum desc"|"sampleData"|"sampleData desc"|"separator"|"separator desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("NameFormatGO_externalCode"|"createdBy"|"createdDate"|"createdDateTime"|"externalCode"|"lastModifiedBy"|"lastModifiedDate"|"lastModifiedDateTime"|"lastModifiedDateWithTZ"|"mdfSystemEffectiveEndDate"|"mdfSystemEffectiveStartDate"|"mdfSystemEntityId"|"mdfSystemObjectType"|"mdfSystemRecordId"|"mdfSystemRecordStatus"|"mdfSystemStatus"|"mdfSystemTransactionSequence"|"mdfSystemVersionId"|"nameArtifactEnum"|"sampleData"|"separator")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListNameFormatGOsQueries

Represents the Queries record for the operation: listNameFormatGOs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"externalCode"|"externalCode desc"|"externalName"|"externalName desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"mdfSystemCreatedBy"|"mdfSystemCreatedBy desc"|"mdfSystemCreatedDate"|"mdfSystemCreatedDate desc"|"mdfSystemEffectiveEndDate"|"mdfSystemEffectiveEndDate desc"|"mdfSystemEffectiveStartDate"|"mdfSystemEffectiveStartDate desc"|"mdfSystemEntityId"|"mdfSystemEntityId desc"|"mdfSystemLastModifiedBy"|"mdfSystemLastModifiedBy desc"|"mdfSystemLastModifiedDate"|"mdfSystemLastModifiedDate desc"|"mdfSystemLastModifiedDateWithTZ"|"mdfSystemLastModifiedDateWithTZ desc"|"mdfSystemObjectType"|"mdfSystemObjectType desc"|"mdfSystemRecordId"|"mdfSystemRecordId desc"|"mdfSystemRecordStatus"|"mdfSystemRecordStatus desc"|"mdfSystemStatus"|"mdfSystemStatus desc"|"mdfSystemTransactionSequence"|"mdfSystemTransactionSequence desc"|"mdfSystemVersionId"|"mdfSystemVersionId desc"|"sample"|"sample desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"nameElements")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("createdBy"|"createdDateTime"|"externalCode"|"externalName"|"lastModifiedBy"|"lastModifiedDateTime"|"mdfSystemCreatedBy"|"mdfSystemCreatedDate"|"mdfSystemEffectiveEndDate"|"mdfSystemEffectiveStartDate"|"mdfSystemEntityId"|"mdfSystemLastModifiedBy"|"mdfSystemLastModifiedDate"|"mdfSystemLastModifiedDateWithTZ"|"mdfSystemObjectType"|"mdfSystemRecordId"|"mdfSystemRecordStatus"|"mdfSystemStatus"|"mdfSystemTransactionSequence"|"mdfSystemVersionId"|"sample")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerAddressDEFLTsQueries

Represents the Queries record for the operation: listPerAddressDEFLTs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("address1"|"address1 desc"|"address2"|"address2 desc"|"address3"|"address3 desc"|"address4"|"address4 desc"|"address5"|"address5 desc"|"addressType"|"addressType desc"|"city"|"city desc"|"country"|"country desc"|"county"|"county desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"empUsersSysId"|"empUsersSysId desc"|"endDate"|"endDate desc"|"includeAllRecords"|"includeAllRecords desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"notes"|"notes desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"province"|"province desc"|"startDate"|"startDate desc"|"state"|"state desc"|"zipCode"|"zipCode desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("address1"|"address2"|"address3"|"address4"|"address5"|"addressType"|"city"|"country"|"county"|"createdBy"|"createdDateTime"|"createdOn"|"empUsersSysId"|"endDate"|"includeAllRecords"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"notes"|"operation"|"personIdExternal"|"province"|"startDate"|"state"|"zipCode")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerBiographicalInfoLocBRAsQueries

Represents the Queries record for the operation: listPerBiographicalInfoLocBRAs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"customString1"|"customString1 desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"placeOfBirth"|"placeOfBirth desc"|"regionOfBirth"|"regionOfBirth desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerBiographicalInfoLocCHLsQueries

Represents the Queries record for the operation: listPerBiographicalInfoLocCHLs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"customString1"|"customString1 desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"placeOfBirth"|"placeOfBirth desc"|"regionOfBirth"|"regionOfBirth desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerBiographicalInfoLocFRAsQueries

Represents the Queries record for the operation: listPerBiographicalInfoLocFRAs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"customString1"|"customString1 desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"placeOfBirth"|"placeOfBirth desc"|"regionOfBirth"|"regionOfBirth desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerBiographicalInfoLocITAsQueries

Represents the Queries record for the operation: listPerBiographicalInfoLocITAs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"customString1"|"customString1 desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"placeOfBirth"|"placeOfBirth desc"|"regionOfBirth"|"regionOfBirth desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerBiographicalInfoLocVENsQueries

Represents the Queries record for the operation: listPerBiographicalInfoLocVENs

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"customString1"|"customString1 desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"placeOfBirth"|"placeOfBirth desc"|"regionOfBirth"|"regionOfBirth desc")[] - Order items by property values, see OData Sorting

\$count? boolean - Include count of items, see OData Count

\$select? ("country"|"createdBy"|"createdDateTime"|"createdOn"|"customString1"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"placeOfBirth"|"regionOfBirth")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerEmailsQueries

Represents the Queries record for the operation: listPerEmails

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"emailAddress"|"emailAddress desc"|"emailType"|"emailType desc"|"includeAllRecords"|"includeAllRecords desc"|"isPrimary"|"isPrimary desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("createdBy"|"createdDateTime"|"createdOn"|"emailAddress"|"emailType"|"includeAllRecords"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerEmergencyContactssQueries

Represents the Queries record for the operation: listPerEmergencyContactss

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("addressAddress1"|"addressAddress1 desc"|"addressAddress2"|"addressAddress2 desc"|"addressAddress3"|"addressAddress3 desc"|"addressCity"|"addressCity desc"|"addressCountry"|"addressCountry desc"|"addressCounty"|"addressCounty desc"|"addressProvince"|"addressProvince desc"|"addressState"|"addressState desc"|"addressZipCode"|"addressZipCode desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"email"|"email desc"|"isAddSameAsEmployee"|"isAddSameAsEmployee desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"name"|"name desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"phone"|"phone desc"|"primaryFlag"|"primaryFlag desc"|"relationship"|"relationship desc"|"secondPhone"|"secondPhone desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"addressNavDEFLT"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("addressAddress1"|"addressAddress2"|"addressAddress3"|"addressCity"|"addressCountry"|"addressCounty"|"addressProvince"|"addressState"|"addressZipCode"|"createdBy"|"createdDateTime"|"createdOn"|"email"|"isAddSameAsEmployee"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"name"|"operation"|"personIdExternal"|"phone"|"primaryFlag"|"relationship"|"secondPhone")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerNationalIdsQueries

Represents the Queries record for the operation: listPerNationalIds

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("cardType"|"cardType desc"|"country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"isPrimary"|"isPrimary desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"nationalId"|"nationalId desc"|"notes"|"notes desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("cardType"|"country"|"createdBy"|"createdDateTime"|"createdOn"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"nationalId"|"notes"|"operation"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerNationalIdWithValidityPeriodsQueries

Represents the Queries record for the operation: listPerNationalIdWithValidityPeriods

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("cardType"|"cardType desc"|"country"|"country desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"isPrimary"|"isPrimary desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"nationalId"|"nationalId desc"|"personIdExternal"|"personIdExternal desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("cardType"|"country"|"createdBy"|"createdDateTime"|"createdOn"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"nationalId"|"notes"|"personIdExternal")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerPersonalsQueries

Represents the Queries record for the operation: listPerPersonals

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("attachmentId"|"attachmentId desc"|"businessFirstName"|"businessFirstName desc"|"businessLastName"|"businessLastName desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"displayName"|"displayName desc"|"endDate"|"endDate desc"|"firstName"|"firstName desc"|"gender"|"gender desc"|"includeAllRecords"|"includeAllRecords desc"|"initials"|"initials desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"lastName"|"lastName desc"|"maritalStatus"|"maritalStatus desc"|"middleName"|"middleName desc"|"nationality"|"nationality desc"|"nativePreferredLang"|"nativePreferredLang desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"preferredName"|"preferredName desc"|"salutation"|"salutation desc"|"script"|"script desc"|"startDate"|"startDate desc"|"title"|"title desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("attachmentId"|"businessFirstName"|"businessLastName"|"createdBy"|"createdDateTime"|"createdOn"|"displayName"|"endDate"|"firstName"|"gender"|"includeAllRecords"|"initials"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"lastName"|"maritalStatus"|"middleName"|"nationality"|"nativePreferredLang"|"operation"|"personIdExternal"|"preferredName"|"salutation"|"script"|"startDate"|"title")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerPersonRelationshipsQueries

Represents the Queries record for the operation: listPerPersonRelationships

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("addressAddress1"|"addressAddress1 desc"|"addressAddress2"|"addressAddress2 desc"|"addressAddress3"|"addressAddress3 desc"|"addressCity"|"addressCity desc"|"addressCountry"|"addressCountry desc"|"addressCounty"|"addressCounty desc"|"addressProvince"|"addressProvince desc"|"addressState"|"addressState desc"|"addressZipCode"|"addressZipCode desc"|"attachmentId"|"attachmentId desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"endDate"|"endDate desc"|"firstName"|"firstName desc"|"isAccompanyingDependent"|"isAccompanyingDependent desc"|"isAddressSameAsPerson"|"isAddressSameAsPerson desc"|"isBeneficiary"|"isBeneficiary desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"lastName"|"lastName desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"relatedPersonIdExternal"|"relatedPersonIdExternal desc"|"relationshipType"|"relationshipType desc"|"startDate"|"startDate desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav"|"relNationalIdNav"|"relPersonNav"|"relPersonalNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("addressAddress1"|"addressAddress2"|"addressAddress3"|"addressCity"|"addressCountry"|"addressCounty"|"addressProvince"|"addressState"|"addressZipCode"|"attachmentId"|"createdBy"|"createdDateTime"|"createdOn"|"endDate"|"firstName"|"isAccompanyingDependent"|"isAddressSameAsPerson"|"isBeneficiary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"lastName"|"operation"|"personIdExternal"|"relatedPersonIdExternal"|"relationshipType"|"startDate")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerPersonsQueries

Represents the Queries record for the operation: listPerPersons

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("birthName"|"birthName desc"|"countryOfBirth"|"countryOfBirth desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"dateOfBirth"|"dateOfBirth desc"|"includeAllRecords"|"includeAllRecords desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"perPersonUuid"|"perPersonUuid desc"|"personId"|"personId desc"|"personIdExternal"|"personIdExternal desc"|"regionOfBirth"|"regionOfBirth desc"|"userId"|"userId desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"emailNav"|"emergencyContactNav"|"homeAddressNavDEFLT"|"nationalIdNav"|"personRerlationshipNav"|"personalInfoNav"|"phoneNav"|"socialAccountNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("birthName"|"countryOfBirth"|"createdBy"|"createdDateTime"|"createdOn"|"dateOfBirth"|"includeAllRecords"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"perPersonUuid"|"personId"|"personIdExternal"|"regionOfBirth"|"userId")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerPhonesQueries

Represents the Queries record for the operation: listPerPhones

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("areaCode"|"areaCode desc"|"countryCode"|"countryCode desc"|"createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"extension"|"extension desc"|"includeAllRecords"|"includeAllRecords desc"|"isPrimary"|"isPrimary desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"phoneNumber"|"phoneNumber desc"|"phoneType"|"phoneType desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("areaCode"|"countryCode"|"createdBy"|"createdDateTime"|"createdOn"|"extension"|"includeAllRecords"|"isPrimary"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"phoneNumber"|"phoneType")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPerSocialAccountsQueries

Represents the Queries record for the operation: listPerSocialAccounts

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("createdBy"|"createdBy desc"|"createdDateTime"|"createdDateTime desc"|"createdOn"|"createdOn desc"|"domain"|"domain desc"|"imId"|"imId desc"|"lastModifiedBy"|"lastModifiedBy desc"|"lastModifiedDateTime"|"lastModifiedDateTime desc"|"lastModifiedOn"|"lastModifiedOn desc"|"operation"|"operation desc"|"personIdExternal"|"personIdExternal desc"|"url"|"url desc")[] - Order items by property values, see OData Sorting

\$expand? ("*"|"personNav")[] - Expand related entities, see OData Expand

\$count? boolean - Include count of items, see OData Count

\$select? ("createdBy"|"createdDateTime"|"createdOn"|"domain"|"imId"|"lastModifiedBy"|"lastModifiedDateTime"|"lastModifiedOn"|"operation"|"personIdExternal"|"url")[] - Select properties to be returned, see OData Select

sap.successfactors.ecpersonalinformation: ListPersonKeysQueries

Represents the Queries record for the operation: listPersonKeys

Fields

\$skip? int - Skip the first n items, see OData Paging - Skip

\$top int(default 20) - Show only the first n items, see OData Paging - Top

\$filter? string - Filter items by property values, see OData Filtering

\$search? string - Search items by search phrases, see OData Searching

\$orderby? ("perPersonUuid"|"perPersonUuid desc"|"personId"|"personId desc"|"personIdExternal"|"personIdExternal desc")[] - Order items by property values, see OData Sorting