Jump to

• Request
• Response
• Examples

Update a photo

patch

/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}

Request

Path Parameters

• ImageId(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=
• empsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Employees resource and used to uniquely identify an instance of Employees. The client should not generate the hash key value. Instead, the client should query on the Employees collection resource in order to navigate to a specific instance of Employees 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Image: string (byte)
  Title: Image

  Unique location of the image. Encrypted version of the file.
• ImageName: string
  Title: Photo Name

  Maximum Length: 240

  Name of the image.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time a row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 30

  Default Value: false

  Indicates whether the image is primary.

{
    "type":"object",
    "properties":{
        "ImageName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image.",
            "nullable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the image is primary.",
            "nullable":false,
            "default":false
        },
        "Image":{
            "title":"Image",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time a row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : emps-photo-item-response

Type: object

Show Source

• Image: string (byte)
  Title: Image

  Unique location of the image. Encrypted version of the file.
• ImageId: integer (int64)
  Title: Photo ID
• ImageName: string
  Title: Photo Name

  Maximum Length: 240

  Name of the image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time a row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PersonId: integer (int64)
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 30

  Default Value: false

  Indicates whether the image is primary.

{
    "type":"object",
    "properties":{
        "ImageName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the image is primary.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time a row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ImageId":{
            "title":"Photo ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Image":{
            "title":"Image",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to update an employee photo by submitting a PATCH request on the REST resource using cURL.

curl -X PATCH -H "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json"  -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps/000200000069ACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787200106A6176612E6C616E672E4F626A656374000000000000000000000078707708000000E80CEBE980780000000EACED0005770800005AF310F6AAA1/child/photo/100000018659715"

Note:

• Always execute PATCH operations against the self link returned in the GET response.
• Use any third-party tool to convert the image into an encrypted file (base 64) and provide the encrypted version in the payload.

Example of Payload

The following shows an example of the payload

{
  "ImageName" : "Image-2",
  "PrimaryFlag" : "Y",
  "Image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDRYPDQwMDRsUFRAWIB0iIiAdHx8kKDQsJCYxJx8fLT0tMTU3Ojo6Iys/RD84QzQ5OjcBCgoKDQwNGg8PGjclHyU3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N//AABEIAIEAVQMBIgACEQEDEQH/xAAcAAABBAMBAAAAAAAAAAAAAAAFAAMEBgECBwj/xAA9EAACAQMBBgMDCQYHAQAAAAABAgMABBEFBhIhMUFREyJhFXGBBzJCYpGhscHRFCNScvDxMzQ1NnOCshb/xAAZAQACAwEAAAAAAAAAAAAAAAADBAABAgX/xAAiEQACAgICAgIDAAAAAAAAAAAAAQIRAyESMQQyE0EiQlH/2gAMAwEAAhEDEQA/AOhaR5LRfdVT2m/zqmrLou/JaAjjwqq7TpMb1cA0CHubfQOmy0JzQYPiQjOONEpTMkRyDihkCM8juThVRmLjpjt65roYMixptgJRbeiUoVR55ACehp21I3t8Hy550AK3gvzCLWSRuvX+9EoZprB9+a1ZY25p0Bqn5Zr4XVhoXEUnkEik9s0D2iiCwGo2oXqXB34UjAHPD8RW9zm+01Ylc+OB9I8+3GrWZSVGXBrZX5LfyArxqKwI4Gpllv75WXgRwIPStb6MeJlRwrBtrVkULkUqznFKoZPQmxrGXS42bqooBtXII9QT40d2Kbd0aL+Sq7teN69U++koewZ9APUZ2dYo0yFdvOcdPSlbWzTB4IoW3QAAijn7/wCu1RG8UXaEShUV1AU9c/h1q46JGNx58HMzF89+1TLJoNggmxaJo0topmnO9O/MjiEHYfrUy7s4Z1ImjR+mCKIIS0f7tl4c8mo8hkwd4cs8e9L2Ooo+vbK6fI5mhi8KQD50Zx9tUSdbnTXS3ZjIqMSrfV4H9a67q53Yjy9eNc61qNH1RADwUccdqPhbFs8V2CHl32WVTne5++lIwKca0kTAkCD5r5ODypgscU6naEWNtkmlWRxpVqjB6E2TULpUQH8IoBtOAbwUe2UBOlxn6oqvbS5F+KRh7Bn0ALi1aa6hhVCPE+n2A5/jVnWR7VVSKNnzwCr0qFkLHCynIAHIciRRa0ff3QVCn+Ic6Dkds6OKCitAVZ7uXVXC293bsvNZFID4x6ffUvanVm0axjlkHiSSEBVU82PIUQkgETGQ58RzjeJycVVdrk8TVNOWbBi8UAI3Vh0NZjG2bdpWMR3GqSuLjVzFFG3BYPEBcD1FVTW5DHePLETjf3W/Cui6rYW19AklxBASi7qybuGAHSqNtDHboWihIfkzt1JzRsXYvnTrYCjbMD4Bwccfjypk8qIsYltHThne4HqeAodinoqkc+XYk5UqSqaVEoyeiNlhjSowR9EVW9qU3rwbvarTs/j2emO1V3aD/O49KRj7Bn0QBNF+wQwtIFkBwFxxY8amWUxUCTOMD7KD3p8PcIHJxU6JP2i1MEchUk5R1547ig5ocNj/AI2TkqJ94DIPFN6kU8px5wCAvQAVQdqE1ufVBh7d40YmJkkyc9Dg9jVj9jztIVljM8ignLTkAj7BVf2ktLhQrLZGIoAsQSZTn7TWYf0JO2iw6rdtHpaySALI0QZgDwBI41z28kMh3UPnkyc5xxo2Xvv/AJi49qRlN1ljiJb5xPMfCg62zCNLgMMKMFSOfu+OaPgi3dC/kTWrBbElt3OQOFOqnCm14SNnvTofBFPxSOdJ2PLBw41msG4GBWaP+IPZ3zZp97S0b6oqr7ST7t/8Ks2zGPZMf8oqs7TGKK4aWZlRFHFmOAK5UHcxt9Fd1bUEt4I3mOAZVQepJqdHeyabqCwTL+5PGOQdB2IqqKX2o2p0qytRiEXKFQ30gGBYn4Cun7abMhWMm6xtXbKuvOInp7qmdaTC+PLbX2DtbLz6S0lpIouAAEzxB9KAR2d8Ct9fvGfCJHhAZ82OBH20L1T2ppSFXLS2+ch1PzT2P9daEXW118qmKMyICu7n+vhS8YX0Myy12hnV7+d7wxzO+4JCwjPc8M4+FTVI9nRDn5ePvzQvRdMutXvBI28sRPmlPb07mmZtQistV1CzQ5tBcPuHmU48vdXSww4qzn5pcjRjiRvfSJrXfWRiyMCp6isnlWwRkHNKtRWKuyUXuT5R763sRZ6Taxw4XBnm87fBeQ+OaqF9qN7qM/i311LcOerty9w5D4VFdgoz1raPG6GPKl1FLoJYV2UkMO1mlSIxV0nDKR37fHl8a7f8om3dnslbR24hW8v7kfu7cnChP4n9OBwOv2kcCt5GtJorlf8AEikVx6YOas3ykbNajqb3W11o73ejyRJK8rsFaI+VSirzKjA4+p7ZNvooKWu2mhawViu7b2ZcS4Xw3cPbvns5xuf9hj1qDq2i7JLarqM+09iWzgWcD+LnHTy5P5etVXZvYvXdoUzplg7Ip87uwAXtnJojtPsJr+y9lDd6kkEsMj7u9FJveGeYDZAAzx/WhqEYvkgryyceLHrbaW3KPDaWcsaKh3JHAAOByx0qgv4rtJLKp3pSWPqSc0ZSbMRWVBGrZBUqd4ih4O/vJnJjYrnuByNMPK5Lf0B4pGltbyb65kaPPUc6LpH5cFiT3NQM70qDoFqZDJvLg/OHOsuTJQ54LdCD8azSDUqvmyUMSbjcnIrMcmMBiCBUDxCKzv8ArVUWTpbgEEZruvyO6ol1sesEhBMMhUg9v7g156ZjXQvkh1RoJr2y3j5sOB935ffWoR5OjMnWzvlo1vBEEt0SNB9FRgUP2gtrTWtMuLK9UPbzDcYdfePUHB+FB4L2Xw249a1lvXQIGPXNE+BmfkOObebCy7KmOY3MMlncSFISmRK5AySwxgY9DVPhSND5Rir18setPe6pp9lk7trAzkert+iD7a5+klCca0EuyXu4OQcdKdjRUXy9eZ71EEvCt1nwDngKqiEuDzFyOABxSqNFPuxjPXjSrNkGFbKg1knjTUTc1Nbk0QyImi2yeoezdoLWYnCOfCf3Hl9+KEE1oxOOBweh7VFKnZD0lYsJoCw5E/lWLsDy5HX8qEbC6gNR0aKcHO+oJ9DyI+0Gn9qb39h0K+vTw8OJ90/W3SB9+KftVYvWziG1d/7S2hv7pWyjTFUP1V8o+4ZoWtaenatwaRYwZzWsjHG73ramGOWzVMhu0h70qaJpVmzQ6nz6c6VmlVlMxWrdaVKqIdM+TX/RT/O341O29/2jN/yJ/wChSpUx+oJ+xyA1sKVKlwpk8qaHWlSqERilSpVRZ//Z"
}

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ImageName" : "Image-2",
  "PrimaryFlag" : "Y",
  "ImageId" : 100000018659715,
  "PersonId" : 100000008153761,
  "ObjectVersionNumber" : 2,
  "links" : [4]
     0:  {...
          ...}
}

Back to Top