> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # sap-successfactors-people > SAP SuccessFactors People **Server path:** `/sap-successfactors-people` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | [`sap_successfactors_people_create_background_certificates`](#sap_successfactors_people_create_background_certificates) | Add new entity to Background\_Certificates | | [`sap_successfactors_people_create_background_education`](#sap_successfactors_people_create_background_education) | Add new entity to Background\_Education | | [`sap_successfactors_people_create_background_inside_work_experience`](#sap_successfactors_people_create_background_inside_work_experience) | Add new entity to Background\_InsideWorkExperience | | [`sap_successfactors_people_create_background_languages`](#sap_successfactors_people_create_background_languages) | Add new entity to Background\_Languages | | [`sap_successfactors_people_create_background_outside_work_experience`](#sap_successfactors_people_create_background_outside_work_experience) | Add new entity to Background\_OutsideWorkExperience | | [`sap_successfactors_people_delete_background_certificates`](#sap_successfactors_people_delete_background_certificates) | Delete entity from Background\_Certificates | | [`sap_successfactors_people_delete_background_education`](#sap_successfactors_people_delete_background_education) | Delete entity from Background\_Education | | [`sap_successfactors_people_delete_background_inside_work_experience`](#sap_successfactors_people_delete_background_inside_work_experience) | Delete entity from Background\_InsideWorkExperience | | [`sap_successfactors_people_delete_background_languages`](#sap_successfactors_people_delete_background_languages) | Delete entity from Background\_Languages | | [`sap_successfactors_people_delete_background_outside_work_experience`](#sap_successfactors_people_delete_background_outside_work_experience) | Delete entity from Background\_OutsideWorkExperience | | [`sap_successfactors_people_get_background_certificates`](#sap_successfactors_people_get_background_certificates) | Get entity from Background\_Certificates by key | | [`sap_successfactors_people_get_background_education`](#sap_successfactors_people_get_background_education) | Get entity from Background\_Education by key | | [`sap_successfactors_people_get_background_inside_work_experience`](#sap_successfactors_people_get_background_inside_work_experience) | Get entity from Background\_InsideWorkExperience by key | | [`sap_successfactors_people_get_background_languages`](#sap_successfactors_people_get_background_languages) | Get entity from Background\_Languages by key | | [`sap_successfactors_people_get_background_outside_work_experience`](#sap_successfactors_people_get_background_outside_work_experience) | Get entity from Background\_OutsideWorkExperience by key | | [`sap_successfactors_people_get_emp_employment`](#sap_successfactors_people_get_emp_employment) | Get entity from EmpEmployment by key | | [`sap_successfactors_people_get_emp_job`](#sap_successfactors_people_get_emp_job) | Get entity from EmpJob by key | | [`sap_successfactors_people_get_emp_job_relationships`](#sap_successfactors_people_get_emp_job_relationships) | Get entity from EmpJobRelationships by key | | [`sap_successfactors_people_get_emp_work_permit`](#sap_successfactors_people_get_emp_work_permit) | Get entity from EmpWorkPermit by key | | [`sap_successfactors_people_get_per_address_deflt`](#sap_successfactors_people_get_per_address_deflt) | Get entity from PerAddressDEFLT by key | | [`sap_successfactors_people_get_per_email`](#sap_successfactors_people_get_per_email) | Get entity from PerEmail by key | | [`sap_successfactors_people_get_per_emergency_contacts`](#sap_successfactors_people_get_per_emergency_contacts) | Get entity from PerEmergencyContacts by key | | [`sap_successfactors_people_get_per_national_id`](#sap_successfactors_people_get_per_national_id) | Get entity from PerNationalId by key | | [`sap_successfactors_people_get_per_person`](#sap_successfactors_people_get_per_person) | Get entity from PerPerson by key | | [`sap_successfactors_people_get_per_personal`](#sap_successfactors_people_get_per_personal) | Get entity from PerPersonal by key | | [`sap_successfactors_people_get_per_phone`](#sap_successfactors_people_get_per_phone) | Get entity from PerPhone by key | | [`sap_successfactors_people_list_background_certificates`](#sap_successfactors_people_list_background_certificates) | Get entities from Background\_Certificates | | [`sap_successfactors_people_list_background_education`](#sap_successfactors_people_list_background_education) | Get entities from Background\_Education | | [`sap_successfactors_people_list_background_inside_work_experience`](#sap_successfactors_people_list_background_inside_work_experience) | Get entities from Background\_InsideWorkExperience | | [`sap_successfactors_people_list_background_languages`](#sap_successfactors_people_list_background_languages) | Get entities from Background\_Languages | | [`sap_successfactors_people_list_background_outside_work_experience`](#sap_successfactors_people_list_background_outside_work_experience) | Get entities from Background\_OutsideWorkExperience | | [`sap_successfactors_people_list_emp_employment`](#sap_successfactors_people_list_emp_employment) | Get entities from EmpEmployment | | [`sap_successfactors_people_list_emp_job`](#sap_successfactors_people_list_emp_job) | Get entities from EmpJob | | [`sap_successfactors_people_list_emp_job_relationships`](#sap_successfactors_people_list_emp_job_relationships) | Get entities from EmpJobRelationships | | [`sap_successfactors_people_list_emp_work_permit`](#sap_successfactors_people_list_emp_work_permit) | Get entities from EmpWorkPermit | | [`sap_successfactors_people_list_per_address_deflt`](#sap_successfactors_people_list_per_address_deflt) | Get entities from PerAddressDEFLT | | [`sap_successfactors_people_list_per_email`](#sap_successfactors_people_list_per_email) | Get entities from PerEmail | | [`sap_successfactors_people_list_per_emergency_contacts`](#sap_successfactors_people_list_per_emergency_contacts) | Get entities from PerEmergencyContacts | | [`sap_successfactors_people_list_per_national_id`](#sap_successfactors_people_list_per_national_id) | Get entities from PerNationalId | | [`sap_successfactors_people_list_per_person`](#sap_successfactors_people_list_per_person) | Get entities from PerPerson | | [`sap_successfactors_people_list_per_personal`](#sap_successfactors_people_list_per_personal) | Get entities from PerPersonal | | [`sap_successfactors_people_list_per_phone`](#sap_successfactors_people_list_per_phone) | Get entities from PerPhone | | [`sap_successfactors_people_replace_background_certificates`](#sap_successfactors_people_replace_background_certificates) | Update entity in Background\_Certificates | | [`sap_successfactors_people_replace_background_education`](#sap_successfactors_people_replace_background_education) | Update entity in Background\_Education | | [`sap_successfactors_people_replace_background_inside_work_experience`](#sap_successfactors_people_replace_background_inside_work_experience) | Update entity in Background\_InsideWorkExperience | | [`sap_successfactors_people_replace_background_languages`](#sap_successfactors_people_replace_background_languages) | Update entity in Background\_Languages | | [`sap_successfactors_people_replace_background_outside_work_experience`](#sap_successfactors_people_replace_background_outside_work_experience) | Update entity in Background\_OutsideWorkExperience | *** ## sap\_successfactors\_people\_create\_background\_certificates Add new entity to Background\_Certificates **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `custom1` | integer | No | — | The custom1 value | | `description` | string | No | — | The description value | | `endDate` | string | No | — | End date for filtering | | `institution` | string | No | — | The institution value | | `lastModifiedDate` | string | No | — | Last Modified Date | | `licenseCountry` | string | No | — | License Country | | `licenseName` | string | No | — | License Name | | `licenseNumber` | string | No | — | License Number | | `licenseState` | string | No | — | License State | | `name` | string | No | — | The name value | | `startDate` | string | No | — | Start date for filtering | | `userId` | string | No | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "custom1": { "type": "integer", "description": "The custom1 value" }, "description": { "type": "string", "description": "The description value" }, "endDate": { "type": "string", "description": "End date for filtering" }, "institution": { "type": "string", "description": "The institution value" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "licenseCountry": { "type": "string", "description": "License Country" }, "licenseName": { "type": "string", "description": "License Name" }, "licenseNumber": { "type": "string", "description": "License Number" }, "licenseState": { "type": "string", "description": "License State" }, "name": { "type": "string", "description": "The name value" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_create\_background\_education Add new entity to Background\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `degree` | string | No | — | The degree value | | `degreeDate` | string | No | — | Degree Date | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDate` | string | No | — | Last Modified Date | | `major` | string | No | — | The major value | | `school` | string | No | — | The school value | | `schoolAddress` | string | No | — | School Address | | `schoolCity` | string | No | — | School City | | `schoolCountry` | string | No | — | School Country | | `schoolState` | string | No | — | School State | | `schoolType` | string | No | — | School Type | | `schoolZip` | string | No | — | School Zip | | `startDate` | string | No | — | Start date for filtering | | `userId` | string | No | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "degree": { "type": "string", "description": "The degree value" }, "degreeDate": { "type": "string", "description": "Degree Date" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "major": { "type": "string", "description": "The major value" }, "school": { "type": "string", "description": "The school value" }, "schoolAddress": { "type": "string", "description": "School Address" }, "schoolCity": { "type": "string", "description": "School City" }, "schoolCountry": { "type": "string", "description": "School Country" }, "schoolState": { "type": "string", "description": "School State" }, "schoolType": { "type": "string", "description": "School Type" }, "schoolZip": { "type": "string", "description": "School Zip" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_create\_background\_inside\_work\_experience Add new entity to Background\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `department` | string | No | — | The department value | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDate` | string | No | — | Last Modified Date | | `startDate` | string | No | — | Start date for filtering | | `title` | string | No | — | The title value | | `userId` | string | No | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "department": { "type": "string", "description": "The department value" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "title": { "type": "string", "description": "The title value" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_create\_background\_languages Add new entity to Background\_Languages **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | --------------------- | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `language` | string | No | — | The language value | | `lastModifiedDate` | string | No | — | Last Modified Date | | `readingProf` | string | No | — | Reading Prof | | `speakingProf` | string | No | — | Speaking Prof | | `userId` | string | No | — | User Id | | `variant` | string | No | — | The variant value | | `writingProf` | string | No | — | Writing Prof | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "language": { "type": "string", "description": "The language value" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "readingProf": { "type": "string", "description": "Reading Prof" }, "speakingProf": { "type": "string", "description": "Speaking Prof" }, "userId": { "type": "string", "description": "User Id" }, "variant": { "type": "string", "description": "The variant value" }, "writingProf": { "type": "string", "description": "Writing Prof" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_create\_background\_outside\_work\_experience Add new entity to Background\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------ | | `backgroundElementId` | string | No | — | Background Element Id | | `bgOrderPos` | string | No | — | Bg Order Pos | | `businessType` | string | No | — | Business Type | | `employer` | string | No | — | The employer value | | `employerAddress` | string | No | — | Employer Address | | `employerCity` | string | No | — | Employer City | | `employerContact` | string | No | — | Employer Contact | | `employerCountry` | string | No | — | Employer Country | | `employerEmail` | string | No | — | Employer Email | | `employerPhone` | string | No | — | Employer Phone | | `employerState` | string | No | — | Employer State | | `employerZip` | string | No | — | Employer Zip | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDate` | string | No | — | Last Modified Date | | `presentEmployer` | string | No | — | Present Employer | | `startDate` | string | No | — | Start date for filtering | | `startTitle` | string | No | — | Start Title | | `userId` | string | No | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "string", "description": "Background Element Id" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "businessType": { "type": "string", "description": "Business Type" }, "employer": { "type": "string", "description": "The employer value" }, "employerAddress": { "type": "string", "description": "Employer Address" }, "employerCity": { "type": "string", "description": "Employer City" }, "employerContact": { "type": "string", "description": "Employer Contact" }, "employerCountry": { "type": "string", "description": "Employer Country" }, "employerEmail": { "type": "string", "description": "Employer Email" }, "employerPhone": { "type": "string", "description": "Employer Phone" }, "employerState": { "type": "string", "description": "Employer State" }, "employerZip": { "type": "string", "description": "Employer Zip" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "presentEmployer": { "type": "string", "description": "Present Employer" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "startTitle": { "type": "string", "description": "Start Title" }, "userId": { "type": "string", "description": "User Id" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_delete\_background\_certificates Delete entity from Background\_Certificates **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_delete\_background\_education Delete entity from Background\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_delete\_background\_inside\_work\_experience Delete entity from Background\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_delete\_background\_languages Delete entity from Background\_Languages **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_delete\_background\_outside\_work\_experience Delete entity from Background\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `If-Match` | string | No | — | ETag | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "If-Match": { "type": "string", "description": "ETag" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_background\_certificates Get entity from Background\_Certificates by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "custom1", "description", "endDate", "institution", "lastModifiedDate", "licenseCountry", "licenseName", "licenseNumber", "licenseState", "name", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_background\_education Get entity from Background\_Education by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "degree", "degreeDate", "endDate", "lastModifiedDate", "major", "school", "schoolAddress", "schoolCity", "schoolCountry", "schoolState", "schoolType", "schoolZip", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_background\_inside\_work\_experience Get entity from Background\_InsideWorkExperience by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "department", "endDate", "lastModifiedDate", "startDate", "title", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_background\_languages Get entity from Background\_Languages by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "language", "lastModifiedDate", "readingProf", "speakingProf", "userId", "variant", "writingProf" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_background\_outside\_work\_experience Get entity from Background\_OutsideWorkExperience by key **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "businessType", "employer", "employerAddress", "employerCity", "employerContact", "employerCountry", "employerEmail", "employerPhone", "employerState", "employerZip", "endDate", "lastModifiedDate", "presentEmployer", "startDate", "startTitle", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_emp\_employment Get entity from EmpEmployment by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "StockEndDate", "assignmentClass", "benefitsEligibilityStartDate", "benefitsEndDate", "bonusPayExpirationDate", "createdBy", "createdDateTime", "createdOn", "eligibleForSalContinuation", "eligibleForStock", "employeeFirstEmployment", "endDate", "firstDateWorked", "includeAllRecords", "initialOptionGrant", "initialStockGrant", "isContingentWorker", "isECRecord", "jobNumber", "lastDateWorked", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "okToRehire", "originalStartDate", "payrollEndDate", "personIdExternal", "prevEmployeeId", "professionalServiceDate", "regretTermination", "salaryEndDate", "seniorityDate", "serviceDate", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "empBeneficiaryNav", "empJobRelationshipNav", "empPensionPayoutNav", "empWorkPermitNav", "jobInfoNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "personIdExternal", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_emp\_job Get entity from EmpJob by key **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `seqNumber` | integer | Yes | — | key: seqNumber | | `startDate` | string | Yes | — | key: startDate | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "seqNumber": { "type": "integer", "description": "key: seqNumber" }, "startDate": { "type": "string", "description": "key: startDate" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "assedicCertInitialStateNum", "assedicCertObjectNum", "businessUnit", "calcMethodIndicator", "commitmentIndicator", "company", "contractReferenceForAed", "contractType", "costCenter", "countryOfCompany", "createdBy", "createdDateTime", "createdOn", "defaultOvertimeCompensationVariant", "department", "division", "eeo1JobCategory", "eeo4JobCategory", "eeo5JobCategory", "eeo6JobCategory", "eeoClass", "electoralCollegeForWorkersRepresentatives", "electoralCollegeForWorksCouncil", "empRelationship", "emplStatus", "employeeClass", "employeeWorkgroupMembership", "employmentType", "endDate", "event", "eventReason", "exclExecutiveSector", "expectedReturnDate", "familyRelationshipWithEmployer", "fgtsDate", "fgtsOptant", "fgtsPercent", "flsaStatus", "fte", "harmfulAgentExposure", "hazard", "healthRisk", "holidayCalendarCode", "isCompetitionClauseActive", "isFulltimeEmployee", "isSideLineJobAllowed", "jobCode", "jobTitle", "laborProtection", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "location", "managerId", "mandatoryWorkBreakRecord", "municipalInseeCode", "notes", "operation", "payGrade", "payScaleArea", "payScaleGroup", "payScaleLevel", "payScaleType", "pcfm", "pensionProtection", "permitIndicator", "position", "positionEntryDate", "probationPeriodEndDate", "regularTemp", "residentVote", "retired", "seqNumber", "sickPaySupplement", "standardHours", "startDate", "teachersPension", "timeRecordingAdmissibilityCode", "timeRecordingProfileCode", "timeRecordingVariant", "timeTypeProfileCode", "timezone", "travelDistance", "tupeOrgNumber", "userId", "workLocation", "workerCategory", "workingDaysPerWeek", "workingTimeDirective", "workscheduleCode", "wtdHoursLimit" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "employmentNav", "managerEmploymentNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "seqNumber", "startDate", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_emp\_job\_relationships Get entity from EmpJobRelationships by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `relationshipType` | string | Yes | — | key: relationshipType | | `startDate` | string | Yes | — | key: startDate | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "relationshipType": { "type": "string", "description": "key: relationshipType" }, "startDate": { "type": "string", "description": "key: startDate" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "createdBy", "createdDateTime", "createdOn", "endDate", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "operation", "relUserId", "relationshipType", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "employmentNav", "relEmploymentNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "relationshipType", "startDate", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_emp\_work\_permit Get entity from EmpWorkPermit by key **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `country` | string | Yes | — | key: country | | `documentNumber` | string | Yes | — | key: documentNumber | | `documentType` | string | Yes | — | key: documentType | | `userId` | string | Yes | — | key: userId | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "country": { "type": "string", "description": "key: country" }, "documentNumber": { "type": "string", "description": "key: documentNumber" }, "documentType": { "type": "string", "description": "key: documentType" }, "userId": { "type": "string", "description": "key: userId" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "attachment", "attachmentFileName", "attachmentFileSize", "attachmentFileType", "attachmentId", "attachmentMimeType", "attachmentStatus", "country", "createdBy", "createdDateTime", "createdOn", "documentNumber", "documentTitle", "documentType", "expirationDate", "isValidated", "issueDate", "issuePlace", "issuingAuthority", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "notes", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "employmentNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "country", "documentNumber", "documentType", "userId" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_address\_deflt Get entity from PerAddressDEFLT by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `addressType` | string | Yes | — | key: addressType | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `startDate` | string | Yes | — | key: startDate | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "addressType": { "type": "string", "description": "key: addressType" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "startDate": { "type": "string", "description": "key: startDate" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "addressType", "personIdExternal", "startDate" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_email Get entity from PerEmail by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `emailType` | string | Yes | — | key: emailType | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "emailType": { "type": "string", "description": "key: emailType" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "createdBy", "createdDateTime", "createdOn", "emailAddress", "emailType", "includeAllRecords", "isPrimary", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "operation", "personIdExternal" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "emailType", "personIdExternal" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_emergency\_contacts Get entity from PerEmergencyContacts by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | key: name | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `relationship` | string | Yes | — | key: relationship | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "key: name" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "relationship": { "type": "string", "description": "key: relationship" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "addressAddress1", "addressAddress2", "addressAddress3", "addressCity", "addressCountry", "addressCounty", "addressProvince", "addressState", "addressZipCode", "createdBy", "createdDateTime", "createdOn", "email", "isAddSameAsEmployee", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "name", "operation", "personIdExternal", "phone", "primaryFlag", "relationship", "secondPhone" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "addressNavDEFLT", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "name", "personIdExternal", "relationship" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_national\_id Get entity from PerNationalId by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `cardType` | string | Yes | — | key: cardType | | `country` | string | Yes | — | key: country | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cardType": { "type": "string", "description": "key: cardType" }, "country": { "type": "string", "description": "key: country" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "cardType", "country", "createdBy", "createdDateTime", "createdOn", "isPrimary", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "nationalId", "notes", "operation", "personIdExternal" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "cardType", "country", "personIdExternal" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_person Get entity from PerPerson by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "birthName", "countryOfBirth", "createdBy", "createdDateTime", "createdOn", "dateOfBirth", "includeAllRecords", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "perPersonUuid", "personId", "personIdExternal", "regionOfBirth", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "emailNav", "emergencyContactNav", "homeAddressNavDEFLT", "nationalIdNav", "personRerlationshipNav", "personalInfoNav", "phoneNav", "socialAccountNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "personIdExternal" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_personal Get entity from PerPersonal by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `startDate` | string | Yes | — | key: startDate | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "startDate": { "type": "string", "description": "key: startDate" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "personIdExternal", "startDate" ] } ``` *** ## sap\_successfactors\_people\_get\_per\_phone Get entity from PerPhone by key **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `personIdExternal` | string | Yes | — | key: personIdExternal | | `phoneType` | string | Yes | — | key: phoneType | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "personIdExternal": { "type": "string", "description": "key: personIdExternal" }, "phoneType": { "type": "string", "description": "key: phoneType" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "areaCode", "countryCode", "createdBy", "createdDateTime", "createdOn", "extension", "includeAllRecords", "isPrimary", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "operation", "personIdExternal", "phoneNumber", "phoneType" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID", "personIdExternal", "phoneType" ] } ``` *** ## sap\_successfactors\_people\_list\_background\_certificates Get entities from Background\_Certificates **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "custom1", "custom1 desc", "description", "description desc", "endDate", "endDate desc", "institution", "institution desc", "lastModifiedDate", "lastModifiedDate desc", "licenseCountry", "licenseCountry desc", "licenseName", "licenseName desc", "licenseNumber", "licenseNumber desc", "licenseState", "licenseState desc", "name", "name desc", "startDate", "startDate desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "custom1", "description", "endDate", "institution", "lastModifiedDate", "licenseCountry", "licenseName", "licenseNumber", "licenseState", "name", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_background\_education Get entities from Background\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "degree", "degree desc", "degreeDate", "degreeDate desc", "endDate", "endDate desc", "lastModifiedDate", "lastModifiedDate desc", "major", "major desc", "school", "school desc", "schoolAddress", "schoolAddress desc", "schoolCity", "schoolCity desc", "schoolCountry", "schoolCountry desc", "schoolState", "schoolState desc", "schoolType", "schoolType desc", "schoolZip", "schoolZip desc", "startDate", "startDate desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "degree", "degreeDate", "endDate", "lastModifiedDate", "major", "school", "schoolAddress", "schoolCity", "schoolCountry", "schoolState", "schoolType", "schoolZip", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_background\_inside\_work\_experience Get entities from Background\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "department", "department desc", "endDate", "endDate desc", "lastModifiedDate", "lastModifiedDate desc", "startDate", "startDate desc", "title", "title desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "department", "endDate", "lastModifiedDate", "startDate", "title", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_background\_languages Get entities from Background\_Languages **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "language", "language desc", "lastModifiedDate", "lastModifiedDate desc", "readingProf", "readingProf desc", "speakingProf", "speakingProf desc", "userId", "userId desc", "variant", "variant desc", "writingProf", "writingProf desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "language", "lastModifiedDate", "readingProf", "speakingProf", "userId", "variant", "writingProf" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_background\_outside\_work\_experience Get entities from Background\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "backgroundElementId desc", "bgOrderPos", "bgOrderPos desc", "businessType", "businessType desc", "employer", "employer desc", "employerAddress", "employerAddress desc", "employerCity", "employerCity desc", "employerContact", "employerContact desc", "employerCountry", "employerCountry desc", "employerEmail", "employerEmail desc", "employerPhone", "employerPhone desc", "employerState", "employerState desc", "employerZip", "employerZip desc", "endDate", "endDate desc", "lastModifiedDate", "lastModifiedDate desc", "presentEmployer", "presentEmployer desc", "startDate", "startDate desc", "startTitle", "startTitle desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "backgroundElementId", "bgOrderPos", "businessType", "employer", "employerAddress", "employerCity", "employerContact", "employerCountry", "employerEmail", "employerPhone", "employerState", "employerZip", "endDate", "lastModifiedDate", "presentEmployer", "startDate", "startTitle", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_emp\_employment Get entities from EmpEmployment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "StockEndDate", "StockEndDate desc", "assignmentClass", "assignmentClass desc", "benefitsEligibilityStartDate", "benefitsEligibilityStartDate desc", "benefitsEndDate", "benefitsEndDate desc", "bonusPayExpirationDate", "bonusPayExpirationDate desc", "createdBy", "createdBy desc", "createdDateTime", "createdDateTime desc", "createdOn", "createdOn desc", "eligibleForSalContinuation", "eligibleForSalContinuation desc", "eligibleForStock", "eligibleForStock desc", "employeeFirstEmployment", "employeeFirstEmployment desc", "endDate", "endDate desc", "firstDateWorked", "firstDateWorked desc", "includeAllRecords", "includeAllRecords desc", "initialOptionGrant", "initialOptionGrant desc", "initialStockGrant", "initialStockGrant desc", "isContingentWorker", "isContingentWorker desc", "isECRecord", "isECRecord desc", "jobNumber", "jobNumber desc", "lastDateWorked", "lastDateWorked desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastModifiedOn", "lastModifiedOn desc", "okToRehire", "okToRehire desc", "originalStartDate", "originalStartDate desc", "payrollEndDate", "payrollEndDate desc", "personIdExternal", "personIdExternal desc", "prevEmployeeId", "prevEmployeeId desc", "professionalServiceDate", "professionalServiceDate desc", "regretTermination", "regretTermination desc", "salaryEndDate", "salaryEndDate desc", "seniorityDate", "seniorityDate desc", "serviceDate", "serviceDate desc", "startDate", "startDate desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "StockEndDate", "assignmentClass", "benefitsEligibilityStartDate", "benefitsEndDate", "bonusPayExpirationDate", "createdBy", "createdDateTime", "createdOn", "eligibleForSalContinuation", "eligibleForStock", "employeeFirstEmployment", "endDate", "firstDateWorked", "includeAllRecords", "initialOptionGrant", "initialStockGrant", "isContingentWorker", "isECRecord", "jobNumber", "lastDateWorked", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "okToRehire", "originalStartDate", "payrollEndDate", "personIdExternal", "prevEmployeeId", "professionalServiceDate", "regretTermination", "salaryEndDate", "seniorityDate", "serviceDate", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "empBeneficiaryNav", "empJobRelationshipNav", "empPensionPayoutNav", "empWorkPermitNav", "jobInfoNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_emp\_job Get entities from EmpJob **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "assedicCertInitialStateNum", "assedicCertInitialStateNum desc", "assedicCertObjectNum", "assedicCertObjectNum desc", "businessUnit", "businessUnit desc", "calcMethodIndicator", "calcMethodIndicator desc", "commitmentIndicator", "commitmentIndicator desc", "company", "company desc", "contractReferenceForAed", "contractReferenceForAed desc", "contractType", "contractType desc", "costCenter", "costCenter desc", "countryOfCompany", "countryOfCompany desc", "createdBy", "createdBy desc", "createdDateTime", "createdDateTime desc", "createdOn", "createdOn desc", "defaultOvertimeCompensationVariant", "defaultOvertimeCompensationVariant desc", "department", "department desc", "division", "division desc", "eeo1JobCategory", "eeo1JobCategory desc", "eeo4JobCategory", "eeo4JobCategory desc", "eeo5JobCategory", "eeo5JobCategory desc", "eeo6JobCategory", "eeo6JobCategory desc", "eeoClass", "eeoClass desc", "electoralCollegeForWorkersRepresentatives", "electoralCollegeForWorkersRepresentatives desc", "electoralCollegeForWorksCouncil", "electoralCollegeForWorksCouncil desc", "empRelationship", "empRelationship desc", "emplStatus", "emplStatus desc", "employeeClass", "employeeClass desc", "employeeWorkgroupMembership", "employeeWorkgroupMembership desc", "employmentType", "employmentType desc", "endDate", "endDate desc", "event", "event desc", "eventReason", "eventReason desc", "exclExecutiveSector", "exclExecutiveSector desc", "expectedReturnDate", "expectedReturnDate desc", "familyRelationshipWithEmployer", "familyRelationshipWithEmployer desc", "fgtsDate", "fgtsDate desc", "fgtsOptant", "fgtsOptant desc", "fgtsPercent", "fgtsPercent desc", "flsaStatus", "flsaStatus desc", "fte", "fte desc", "harmfulAgentExposure", "harmfulAgentExposure desc", "hazard", "hazard desc", "healthRisk", "healthRisk desc", "holidayCalendarCode", "holidayCalendarCode desc", "isCompetitionClauseActive", "isCompetitionClauseActive desc", "isFulltimeEmployee", "isFulltimeEmployee desc", "isSideLineJobAllowed", "isSideLineJobAllowed desc", "jobCode", "jobCode desc", "jobTitle", "jobTitle desc", "laborProtection", "laborProtection desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastModifiedOn", "lastModifiedOn desc", "location", "location desc", "managerId", "managerId desc", "mandatoryWorkBreakRecord", "mandatoryWorkBreakRecord desc", "municipalInseeCode", "municipalInseeCode desc", "notes", "notes desc", "operation", "operation desc", "payGrade", "payGrade desc", "payScaleArea", "payScaleArea desc", "payScaleGroup", "payScaleGroup desc", "payScaleLevel", "payScaleLevel desc", "payScaleType", "payScaleType desc", "pcfm", "pcfm desc", "pensionProtection", "pensionProtection desc", "permitIndicator", "permitIndicator desc", "position", "position desc", "positionEntryDate", "positionEntryDate desc", "probationPeriodEndDate", "probationPeriodEndDate desc", "regularTemp", "regularTemp desc", "residentVote", "residentVote desc", "retired", "retired desc", "seqNumber", "seqNumber desc", "sickPaySupplement", "sickPaySupplement desc", "standardHours", "standardHours desc", "startDate", "startDate desc", "teachersPension", "teachersPension desc", "timeRecordingAdmissibilityCode", "timeRecordingAdmissibilityCode desc", "timeRecordingProfileCode", "timeRecordingProfileCode desc", "timeRecordingVariant", "timeRecordingVariant desc", "timeTypeProfileCode", "timeTypeProfileCode desc", "timezone", "timezone desc", "travelDistance", "travelDistance desc", "tupeOrgNumber", "tupeOrgNumber desc", "userId", "userId desc", "workLocation", "workLocation desc", "workerCategory", "workerCategory desc", "workingDaysPerWeek", "workingDaysPerWeek desc", "workingTimeDirective", "workingTimeDirective desc", "workscheduleCode", "workscheduleCode desc", "wtdHoursLimit", "wtdHoursLimit desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "assedicCertInitialStateNum", "assedicCertObjectNum", "businessUnit", "calcMethodIndicator", "commitmentIndicator", "company", "contractReferenceForAed", "contractType", "costCenter", "countryOfCompany", "createdBy", "createdDateTime", "createdOn", "defaultOvertimeCompensationVariant", "department", "division", "eeo1JobCategory", "eeo4JobCategory", "eeo5JobCategory", "eeo6JobCategory", "eeoClass", "electoralCollegeForWorkersRepresentatives", "electoralCollegeForWorksCouncil", "empRelationship", "emplStatus", "employeeClass", "employeeWorkgroupMembership", "employmentType", "endDate", "event", "eventReason", "exclExecutiveSector", "expectedReturnDate", "familyRelationshipWithEmployer", "fgtsDate", "fgtsOptant", "fgtsPercent", "flsaStatus", "fte", "harmfulAgentExposure", "hazard", "healthRisk", "holidayCalendarCode", "isCompetitionClauseActive", "isFulltimeEmployee", "isSideLineJobAllowed", "jobCode", "jobTitle", "laborProtection", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "location", "managerId", "mandatoryWorkBreakRecord", "municipalInseeCode", "notes", "operation", "payGrade", "payScaleArea", "payScaleGroup", "payScaleLevel", "payScaleType", "pcfm", "pensionProtection", "permitIndicator", "position", "positionEntryDate", "probationPeriodEndDate", "regularTemp", "residentVote", "retired", "seqNumber", "sickPaySupplement", "standardHours", "startDate", "teachersPension", "timeRecordingAdmissibilityCode", "timeRecordingProfileCode", "timeRecordingVariant", "timeTypeProfileCode", "timezone", "travelDistance", "tupeOrgNumber", "userId", "workLocation", "workerCategory", "workingDaysPerWeek", "workingTimeDirective", "workscheduleCode", "wtdHoursLimit" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "employmentNav", "managerEmploymentNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_emp\_job\_relationships Get entities from EmpJobRelationships **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "createdBy", "createdBy desc", "createdDateTime", "createdDateTime desc", "createdOn", "createdOn desc", "endDate", "endDate desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastModifiedOn", "lastModifiedOn desc", "operation", "operation desc", "relUserId", "relUserId desc", "relationshipType", "relationshipType desc", "startDate", "startDate desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "createdBy", "createdDateTime", "createdOn", "endDate", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "operation", "relUserId", "relationshipType", "startDate", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "employmentNav", "relEmploymentNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_emp\_work\_permit Get entities from EmpWorkPermit **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "attachment", "attachment desc", "attachmentFileName", "attachmentFileName desc", "attachmentFileSize", "attachmentFileSize desc", "attachmentFileType", "attachmentFileType desc", "attachmentId", "attachmentId desc", "attachmentMimeType", "attachmentMimeType desc", "attachmentStatus", "attachmentStatus desc", "country", "country desc", "createdBy", "createdBy desc", "createdDateTime", "createdDateTime desc", "createdOn", "createdOn desc", "documentNumber", "documentNumber desc", "documentTitle", "documentTitle desc", "documentType", "documentType desc", "expirationDate", "expirationDate desc", "isValidated", "isValidated desc", "issueDate", "issueDate desc", "issuePlace", "issuePlace desc", "issuingAuthority", "issuingAuthority desc", "lastModifiedBy", "lastModifiedBy desc", "lastModifiedDateTime", "lastModifiedDateTime desc", "lastModifiedOn", "lastModifiedOn desc", "notes", "notes desc", "userId", "userId desc" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "attachment", "attachmentFileName", "attachmentFileSize", "attachmentFileType", "attachmentId", "attachmentMimeType", "attachmentStatus", "country", "createdBy", "createdDateTime", "createdOn", "documentNumber", "documentTitle", "documentType", "expirationDate", "isValidated", "issueDate", "issuePlace", "issuingAuthority", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "notes", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "employmentNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_address\_deflt Get entities from PerAddressDEFLT **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_email Get entities from PerEmail **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "createdBy", "createdDateTime", "createdOn", "emailAddress", "emailType", "includeAllRecords", "isPrimary", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "operation", "personIdExternal" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_emergency\_contacts Get entities from PerEmergencyContacts **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "addressAddress1", "addressAddress2", "addressAddress3", "addressCity", "addressCountry", "addressCounty", "addressProvince", "addressState", "addressZipCode", "createdBy", "createdDateTime", "createdOn", "email", "isAddSameAsEmployee", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "name", "operation", "personIdExternal", "phone", "primaryFlag", "relationship", "secondPhone" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "addressNavDEFLT", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_national\_id Get entities from PerNationalId **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "cardType", "country", "createdBy", "createdDateTime", "createdOn", "isPrimary", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "nationalId", "notes", "operation", "personIdExternal" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_person Get entities from PerPerson **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "birthName", "countryOfBirth", "createdBy", "createdDateTime", "createdOn", "dateOfBirth", "includeAllRecords", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "perPersonUuid", "personId", "personIdExternal", "regionOfBirth", "userId" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "emailNav", "emergencyContactNav", "homeAddressNavDEFLT", "nationalIdNav", "personRerlationshipNav", "personalInfoNav", "phoneNav", "socialAccountNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_personal Get entities from PerPersonal **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_list\_per\_phone Get entities from PerPhone **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `$top` | integer | No | — | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$skip` | integer | No | — | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$search` | string | No | — | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$filter` | string | No | — | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$count` | boolean | No | — | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$orderby` | string\[] | No | — | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$select` | string\[] | No | — | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | | `$expand` | string\[] | No | — | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "$top": { "type": "integer", "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$skip": { "type": "integer", "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$search": { "type": "string", "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$filter": { "type": "string", "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$count": { "type": "boolean", "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$orderby": { "type": "array", "items": { "type": "string", "enum": [ "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" ] }, "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$select": { "type": "array", "items": { "type": "string", "enum": [ "areaCode", "countryCode", "createdBy", "createdDateTime", "createdOn", "extension", "includeAllRecords", "isPrimary", "lastModifiedBy", "lastModifiedDateTime", "lastModifiedOn", "operation", "personIdExternal", "phoneNumber", "phoneType" ] }, "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" }, "$expand": { "type": "array", "items": { "type": "string", "enum": [ "*", "personNav" ] }, "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)" } }, "required": [ "PCID" ] } ``` *** ## sap\_successfactors\_people\_replace\_background\_certificates Update entity in Background\_Certificates **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `custom1` | integer | No | — | The custom1 value | | `description` | string | No | — | The description value | | `endDate` | string | No | — | End date for filtering | | `institution` | string | No | — | The institution value | | `lastModifiedDate` | string | No | — | Last Modified Date | | `licenseCountry` | string | No | — | License Country | | `licenseName` | string | No | — | License Name | | `licenseNumber` | string | No | — | License Number | | `licenseState` | string | No | — | License State | | `name` | string | No | — | The name value | | `startDate` | string | No | — | Start date for filtering | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "custom1": { "type": "integer", "description": "The custom1 value" }, "description": { "type": "string", "description": "The description value" }, "endDate": { "type": "string", "description": "End date for filtering" }, "institution": { "type": "string", "description": "The institution value" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "licenseCountry": { "type": "string", "description": "License Country" }, "licenseName": { "type": "string", "description": "License Name" }, "licenseNumber": { "type": "string", "description": "License Number" }, "licenseState": { "type": "string", "description": "License State" }, "name": { "type": "string", "description": "The name value" }, "startDate": { "type": "string", "description": "Start date for filtering" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_replace\_background\_education Update entity in Background\_Education **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `degree` | string | No | — | The degree value | | `degreeDate` | string | No | — | Degree Date | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDate` | string | No | — | Last Modified Date | | `major` | string | No | — | The major value | | `school` | string | No | — | The school value | | `schoolAddress` | string | No | — | School Address | | `schoolCity` | string | No | — | School City | | `schoolCountry` | string | No | — | School Country | | `schoolState` | string | No | — | School State | | `schoolType` | string | No | — | School Type | | `schoolZip` | string | No | — | School Zip | | `startDate` | string | No | — | Start date for filtering | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "degree": { "type": "string", "description": "The degree value" }, "degreeDate": { "type": "string", "description": "Degree Date" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "major": { "type": "string", "description": "The major value" }, "school": { "type": "string", "description": "The school value" }, "schoolAddress": { "type": "string", "description": "School Address" }, "schoolCity": { "type": "string", "description": "School City" }, "schoolCountry": { "type": "string", "description": "School Country" }, "schoolState": { "type": "string", "description": "School State" }, "schoolType": { "type": "string", "description": "School Type" }, "schoolZip": { "type": "string", "description": "School Zip" }, "startDate": { "type": "string", "description": "Start date for filtering" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_replace\_background\_inside\_work\_experience Update entity in Background\_InsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `department` | string | No | — | The department value | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDate` | string | No | — | Last Modified Date | | `startDate` | string | No | — | Start date for filtering | | `title` | string | No | — | The title value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "department": { "type": "string", "description": "The department value" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "title": { "type": "string", "description": "The title value" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_replace\_background\_languages Update entity in Background\_Languages **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `language` | string | No | — | The language value | | `lastModifiedDate` | string | No | — | Last Modified Date | | `readingProf` | string | No | — | Reading Prof | | `speakingProf` | string | No | — | Speaking Prof | | `variant` | string | No | — | The variant value | | `writingProf` | string | No | — | Writing Prof | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "language": { "type": "string", "description": "The language value" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "readingProf": { "type": "string", "description": "Reading Prof" }, "speakingProf": { "type": "string", "description": "Speaking Prof" }, "variant": { "type": "string", "description": "The variant value" }, "writingProf": { "type": "string", "description": "Writing Prof" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ``` *** ## sap\_successfactors\_people\_replace\_background\_outside\_work\_experience Update entity in Background\_OutsideWorkExperience **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------ | | `backgroundElementId` | integer | Yes | — | key: backgroundElementId | | `userId` | string | Yes | — | key: userId | | `bgOrderPos` | string | No | — | Bg Order Pos | | `businessType` | string | No | — | Business Type | | `employer` | string | No | — | The employer value | | `employerAddress` | string | No | — | Employer Address | | `employerCity` | string | No | — | Employer City | | `employerContact` | string | No | — | Employer Contact | | `employerCountry` | string | No | — | Employer Country | | `employerEmail` | string | No | — | Employer Email | | `employerPhone` | string | No | — | Employer Phone | | `employerState` | string | No | — | Employer State | | `employerZip` | string | No | — | Employer Zip | | `endDate` | string | No | — | End date for filtering | | `lastModifiedDate` | string | No | — | Last Modified Date | | `presentEmployer` | string | No | — | Present Employer | | `startDate` | string | No | — | Start date for filtering | | `startTitle` | string | No | — | Start Title | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "backgroundElementId": { "type": "integer", "description": "key: backgroundElementId" }, "userId": { "type": "string", "description": "key: userId" }, "bgOrderPos": { "type": "string", "description": "Bg Order Pos" }, "businessType": { "type": "string", "description": "Business Type" }, "employer": { "type": "string", "description": "The employer value" }, "employerAddress": { "type": "string", "description": "Employer Address" }, "employerCity": { "type": "string", "description": "Employer City" }, "employerContact": { "type": "string", "description": "Employer Contact" }, "employerCountry": { "type": "string", "description": "Employer Country" }, "employerEmail": { "type": "string", "description": "Employer Email" }, "employerPhone": { "type": "string", "description": "Employer Phone" }, "employerState": { "type": "string", "description": "Employer State" }, "employerZip": { "type": "string", "description": "Employer Zip" }, "endDate": { "type": "string", "description": "End date for filtering" }, "lastModifiedDate": { "type": "string", "description": "Last Modified Date" }, "presentEmployer": { "type": "string", "description": "Present Employer" }, "startDate": { "type": "string", "description": "Start date for filtering" }, "startTitle": { "type": "string", "description": "Start Title" } }, "required": [ "PCID", "backgroundElementId", "userId" ] } ```