Create a worker email
post
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails
Request
Path Parameters
-
workersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers 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
-
EmailAddress(required): string
Title:
Email
Maximum Length:240
Email address of the person. -
emailsDFF: array
Email Descriptive Flexfields
Title:
Email Descriptive Flexfields
The emailsDFF resource is a child of the emails resource. It provides all the email descriptive flexfields of a worker as of the specified date. By default, the current date is retained. -
EmailType(required): string
Title:
Type
Maximum Length:30
Type of email such as work, personal, and so on. Valid values are defined in the commonLookupsLOV. -
FromDate: string
(date)
Title:
From Date
Date from when the email address is valid. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the email is the person's primary email. -
ToDate: string
(date)
Title:
To Date
Date until when the email address is valid.
Nested Schema : Email Descriptive Flexfields
Type:
array
Title:
Email Descriptive Flexfields
The emailsDFF resource is a child of the emails resource. It provides all the email descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for email. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EmailAddressId: integer
(int64)
Title:
Email Address ID
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : workers-emails-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
-
EmailAddress: string
Title:
Email
Maximum Length:240
Email address of the person. -
EmailAddressId: integer
(int64)
Title:
Email Address ID
Read Only:true
-
emailsDFF: array
emailsDFF
-
EmailType: string
Title:
Type
Maximum Length:30
Type of email such as work, personal, and so on. Valid values are defined in the commonLookupsLOV. -
EmailTypeMeaning: string
Title:
Email Type
Read Only:true
Maximum Length:80
-
FromDate: string
(date)
Title:
From Date
Date from when the email address is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
-
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the email is the person's primary email. -
ToDate: string
(date)
Title:
To Date
Date until when the email address is valid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workers-emails-emailsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield for email. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EmailAddressId: integer
(int64)
Title:
Email Address ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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
- eMailTypesLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{EmailType}%2CLookupType%3DEMAIL_TYPE
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility. - finder:
- emailsDFF
-
Parameters:
- EmailAddressId:
$request.path.EmailAddressId
- workersUniqID:
$request.path.workersUniqID
The emailsDFF resource is a child of the emails resource. It provides all the email descriptive flexfields of a worker as of the specified date. By default, the current date is retained. - EmailAddressId:
Examples
The following example shows how to create a worker email by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/emails"
Example of Payload
The following is an example of the payload.
{ "EmailType": "W1", "EmailAddress": "example@us.example.com" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 201 Created Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "EmailAddressId": 300100188720510, "EmailType": "W1", "EmailAddress": "example@us.example.com", "FromDate": "2017-01-01", "ToDate": null, "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T12:28:33+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T12:28:33.153+00:00", "PrimaryFlag": true, "links": [ {... } ] }