Create
post
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF
Request
Path Parameters
-
empsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Employees resource and used to uniquely identify an instance of Employees. The client should not generate the hash key value. Instead, the client should query on the Employees collection resource in order to navigate to a specific instance of Employees to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
PersonId: integer
(int64)
Title:
Person ID
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : emps-personDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Title:
Person ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LVVO_V___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_PERSONS_DFF
- finder:
- LVVO___FLEX_Context
-
Parameters:
- finder:
ValidValuesFinder%3BBind_ApplicationId%3D800%2CBind_DescriptiveFlexfieldCode%3DPER_PERSONS_DFF
- finder:
Examples
The following example shows how to create an employee descriptive flexfield by submitting a POST request on the REST resource using cURL.
You can create a flexfield only if there is no flexfield record yet. Typically, the flexfield record is created when the employee is created. This example shows how to create an employee along with a flexfield.
curl -i -u "<username>:<password>" -H " -X POST -d <payload> https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps
Example of Payload
The following is an example of the payload
{ "LastName": "Doe", "FirstName": "John", "WorkEmail" : "john.doe@example.com", "LegalEntityId" : "40010", "assignments" : [ { "BusinessUnitId" : "300100026725086"}], "personDFF" : [ { "testG" : "Group 1" }] }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 201 Created Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "Salutation": null, "FirstName": "John", "MiddleName": null, "LastName": "Doe", "PreviousLastName": null, "NameSuffix": null, "DisplayName": "John Doe", "PreferredName": null, "Honors": null, "CorrespondenceLanguage": null, "PersonNumber": "87683341", "WorkPhoneCountryCode": null, "WorkPhoneAreaCode": null, "WorkPhoneNumber": null, "WorkPhoneExtension": null, "WorkFaxCountryCode": null, "WorkFaxAreaCode": null, "WorkFaxNumber": null, "WorkFaxExtension": null, "WorkMobilePhoneCountryCode": null, "WorkMobilePhoneAreaCode": null, "WorkMobilePhoneNumber": null, "WorkMobilePhoneExtension": null, "HomePhoneCountryCode": null, "HomePhoneAreaCode": null, "HomePhoneNumber": null, "HomePhoneExtension": null, "HomeFaxCountryCode": null, "HomeFaxAreaCode": null, "HomeFaxNumber": null, "HomeFaxExtension": null, "WorkEmail": "john.doe@example.com", "AddressLine1": null, "AddressLine2": null, "AddressLine3": null, "City": null, "Region": null, "Region2": null, "Country": null, "PostalCode": null, "DateOfBirth": null, "Ethnicity": null, "ProjectedTerminationDate": null, "LegalEntityId": 40010, "HireDate": "2017-10-04", "TerminationDate": null, "Gender": null, "MaritalStatus": null, "NationalIdType": null, "NationalId": null, "NationalIdCountry": null, "NationalIdExpirationDate": null, "PersonId": 300100299358411, "EffectiveStartDate": "2017-10-04", "UserName": null, "CitizenshipId": null, "CitizenshipStatus": null, "CitizenshipLegislationCode": null, "CitizenshipToDate": null, "Religion": null, "ReligionId": null, "PassportIssueDate": null, "PassportNumber": null, "PassportIssuingCountry": null, "PassportId": null, "PassportExpirationDate": null, "LicenseNumber": null, "DriversLicenseExpirationDate": null, "DriversLicenseIssuingCountry": null, "DriversLicenseId": null, "MilitaryVetStatus": "N", "CreationDate": "2017-10-04T09:29:21+00:00", "LastUpdateDate": "2017-10-04T09:29:24.268+00:00", "links":[24] 0: {... ...} }