Update a worker phone
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}
Request
Path Parameters
-
PhoneId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the phone number. -
CountryCodeNumber: string
Title:
Country Code
Maximum Length:30
Country code of the phone number. Valid values are defined in the hcmCountriesLov. -
Extension: string
Title:
Extension
Maximum Length:60
Extension number for the phone. -
FromDate: string
(date)
Title:
From Date
Date from when the phone number is valid. -
LegislationCode: string
Title:
Country
Maximum Length:4
Phone legislation code. -
PhoneNumber(required): string
Title:
Number
Maximum Length:60
Phone number of 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 worker. -
ToDate: string
(date)
Title:
To Date
Date until when the 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 : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
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 : workers-phones-item-response
Type:
Show Source
object
-
AreaCode: string
Title:
Area Code
Maximum Length:30
Area code of the phone number. -
CountryCodeNumber: string
Title:
Country Code
Maximum Length:30
Country code of the phone number. Valid values are defined in the hcmCountriesLov. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the phone information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the phone information was created. -
Extension: string
Title:
Extension
Maximum Length:60
Extension number for the phone. -
FromDate: string
(date)
Title:
From Date
Date from when the phone number is valid. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the phone information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the phone information. -
LegislationCode: string
Title:
Country
Maximum Length:4
Phone legislation code. -
LegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Name of the person'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 phone. -
PhoneNumber: string
Title:
Number
Maximum Length:60
Phone number of 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 person's phone type. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:255
Indicates whether the phone number is the primary phone of the worker. -
ToDate: string
(date)
Title:
To Date
Date until when the 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 : workers-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 hcmCountriesLov resource includes the list of values for countries.
- phoneTypesLov
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{PhoneType}%2CLookupType%3DPHONE_TYPE%2CLegislationCode%3D{LegislationCode}
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:
- phonesDFF
-
Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFFParameters:
- PhoneId:
$request.path.PhoneId
- workersUniqID:
$request.path.workersUniqID
- PhoneId:
- validityLovVA
-
Parameters:
- finder:
LegislationCodeFinder%3BLookupCode%3D{Validity}%2CLookupType%3DPER_CONTACT_TIMES%2CLegislationCode%3D{LegislationCode}
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:
Examples
The following example shows how to update a worker phone by submitting a PATCH 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 PATCH -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/phones/300100187109511"
Example of Payload
The following is an example of the payload.
{ "LegislationCode": "IN" }
Example of Response Header
The following is an example of the response header.
Status: HTTP/1.1 200 OK 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.
{ "PhoneId": 300100187109511, "PhoneType": "H1", "LegislationCode": "IN", "CountryCodeNumber": "91", "AreaCode": null, "PhoneNumber": "7543010", "Extension": null, "FromDate": "2019-05-16", "ToDate": null, "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T12:14:49+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T12:21:10+00:00", "PrimaryFlag": true, "links": [ {... } ] }