Update a worker photo
patch
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}
Request
Path Parameters
-
PhotoId(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
-
Photo: string
(byte)
Title:
Photo
Unique location of the image. Encrypted version of the file. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file. -
photosDFF: array
photosDFF
-
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:true
Indicates whether the image is primary.
Nested Schema : workers-photos-photosDFF-item-patch-request
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-photos-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the photo information. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the photo information was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the photo information was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the photo information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Photo: string
(byte)
Title:
Photo
Unique location of the image. Encrypted version of the file. -
PhotoId: integer
(int64)
Title:
Photo ID
Read Only:true
Surrogate identifier for the photo. -
PhotoName: string
Title:
Photo Name
Maximum Length:240
Name of the image file. -
photosDFF: array
photosDFF
-
PhotoType: string
Title:
Type
Maximum Length:30
Default Value:PROFILE
Type of photo such as Profile or Cover. Valid values are defined in the commonLookupsLOV. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:30
Default Value:true
Indicates whether the image is primary.
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-photos-photosDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
ImageId: integer
(int64)
Title:
Photo 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
- photosDFF
-
Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFFParameters:
- PhotoId:
$request.path.PhotoId
- workersUniqID:
$request.path.workersUniqID
- PhotoId:
Examples
The following example shows how to update a worker photo 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/photos/300100187062448"
Example of Payload
The following is an example of the payload.
{ "PhotoName": "Default" }
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.
{ "PhotoId": 300100187062448, "PrimaryFlag": true, "PhotoType": "PROFILE", "PhotoName": "Default", "CreatedBy": "VMOSS", "CreationDate": "2019-05-16T10:20:25+00:00", "LastUpdatedBy": "VMOSS", "LastUpdateDate": "2019-05-16T12:00:01+00:00", "links": [ {... } ] }