Create a phone
post
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones
Request
Path Parameters
-
hcmContactsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the HCM Contacts resource and used to uniquely identify an instance of HCM Contacts. The client should not generate the hash key value. Instead, the client should query on the HCM Contacts collection resource in order to navigate to a specific instance of HCM Contacts 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
-
AreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the contact's phone number. -
CountryCodeNumber: string
Title:
Country Code
Maximum Length:30
Country code of the contact's phone number. Valid values are defined in the hcmCountriesLov. -
Extension: string
Title:
Extension
Maximum Length:60
Extension number for the contact's phone. -
FromDate: string
(date)
Title:
From Date
Date from when the contact's phone number is valid. -
LegislationCode: string
Title:
Country
Maximum Length:4
Legislation code of the contact's phone. -
PhoneNumber(required): string
Title:
Number
Maximum Length:60
Contact's phone number for various phone types such as Work, Home, and so on. -
phonesDFF: array
phonesDFF
-
PhoneType(required): string
Title:
Type
Maximum Length:30
Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the phone number is the primary phone of the contact. -
ToDate: string
(date)
Title:
To Date
Date until when the contact's phone number is valid. -
Validity: string
Title:
Validity
Maximum Length:30
Time of day when a person can be reached at a specific phone number.
Nested Schema : hcmContacts-phones-phonesDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
PhoneId: integer
(int64)
Title:
Phone 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 : hcmContacts-phones-item-response
Type:
Show Source
object
-
AreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the contact's phone number. -
CountryCodeNumber: string
Title:
Country Code
Maximum Length:30
Country code of the contact's phone number. Valid values are defined in the hcmCountriesLov. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact's phone information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact's phone information was created. -
Extension: string
Title:
Extension
Maximum Length:60
Extension number for the contact's phone. -
FromDate: string
(date)
Title:
From Date
Date from when the contact's phone number is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the contact's phone information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact's phone information. -
LegislationCode: string
Title:
Country
Maximum Length:4
Legislation code of the contact's phone. -
LegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the contact's legislation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneId: integer
(int64)
Title:
Phone ID
Read Only:true
Surrogate identifier for the contact's phone. -
PhoneNumber: string
Title:
Number
Maximum Length:60
Contact's phone number for various phone types such as Work, Home, and so on. -
phonesDFF: array
phonesDFF
-
PhoneType: string
Title:
Type
Maximum Length:30
Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV. -
PhoneTypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
Meaning of the contact's phone type. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the phone number is the primary phone of the contact. -
ToDate: string
(date)
Title:
To Date
Date until when the contact's phone number is valid. -
Validity: string
Title:
Validity
Maximum Length:30
Time of day when a person can be reached at a specific phone number. -
ValidityMeaning: string
Title:
Validity
Read Only:true
Maximum Length:80
Description of the phone validity. Valid values are defined in the commonLookupsLOV.
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.
Nested Schema : hcmContacts-phones-phonesDFF-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. -
PhoneId: integer
(int64)
Title:
Phone ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- legislationCodesLov
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegislationCode; Target Attribute: TerritoryCode
- Display Attribute: TerritoryCode, CountryName
- phoneTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{PhoneType}%2CLookupType%3DPHONE_TYPE%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: PhoneType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- phonesDFF
-
Parameters:
- PhoneId:
$request.path.PhoneId
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- PhoneId:
- validityLovVA
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{Validity}%2CLookupType%3DPER_CONTACT_TIMES%2CLegislationCode%3D{LegislationCode}
The following properties are defined on the LOV link relation:- Source Attribute: Validity; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: