Create a communication account
post
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
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
-
AccountName: string
Title:
Account Name
Maximum Length:1000
Name of the contact's communication account. -
EndDate: string
(date)
Title:
To Date
End date of the contact's communication account. -
otherCommunicationAccountsDFF: array
otherCommunicationAccountsDFF
-
Provider(required): string
Title:
Provider
Maximum Length:30
Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV. -
StartDate: string
(date)
Title:
From Date
Start date of the contact's communication account.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DeliveryMethodId: integer
(int64)
Title:
Delivery Method 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-otherCommunicationAccounts-item-response
Type:
Show Source
object
-
AccountName: string
Title:
Account Name
Maximum Length:1000
Name of the contact's communication account. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the contact's communication account information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the contact's communication account information was created. -
DeliveryMethodId: integer
(int64)
Title:
Delivery Method ID
Read Only:true
Surrogate identifier for the contact's delivery method. -
EndDate: string
(date)
Title:
To Date
End date of the contact's communication account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the contact's communication account information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the contact's communication account information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
otherCommunicationAccountsDFF: array
otherCommunicationAccountsDFF
-
Provider: string
Title:
Provider
Maximum Length:30
Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV. -
ProviderMeaning: string
Title:
Provider
Read Only:true
Maximum Length:80
Meaning of the contact's provider type. -
StartDate: string
(date)
Title:
From Date
Start date of the contact's communication account.
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-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
DeliveryMethodId: integer
(int64)
Title:
Delivery Method 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
Links
- otherCommunicationAccountsDFF
-
Parameters:
- DeliveryMethodId:
$request.path.DeliveryMethodId
- hcmContactsUniqID:
$request.path.hcmContactsUniqID
- DeliveryMethodId:
- providersLov
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPER_CM_MTHD
The following properties are defined on the LOV link relation:- Source Attribute: Provider; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: