Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 Photo Descriptive Flexfields
  Title: Photo Descriptive Flexfields

  The photosDFF resource is a child of the photos resource. It provides all the photo descriptive flexfields of a worker as of the specified date. By default, the current date is retained.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 30

  Default Value: true

  Indicates whether the image is primary.

{
    "type":"object",
    "properties":{
        "photosDFF":{
            "title":"Photo Descriptive Flexfields",
            "type":"array",
            "description":"The photosDFF resource is a child of the photos resource. It provides all the photo descriptive flexfields of a worker as of the specified date. By default, the current date is retained.",
            "items":{
                "$ref":"#/components/schemas/workers-photos-photosDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "Photo":{
            "title":"Photo",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the image is primary.",
            "nullable":false,
            "default":true
        },
        "PhotoName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image file.",
            "nullable":false
        }
    }
}

Nested Schema : Photo Descriptive Flexfields

Type: array

Title: Photo Descriptive Flexfields

The photosDFF resource is a child of the photos resource. It provides all the photo descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Show Source

• Array of: object workers-photos-photosDFF-item-patch-request

{
    "title":"Photo Descriptive Flexfields",
    "type":"array",
    "description":"The photosDFF resource is a child of the photos resource. It provides all the photo descriptive flexfields of a worker as of the specified date. By default, the current date is retained.",
    "items":{
        "$ref":"#/components/schemas/workers-photos-photosDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : workers-photos-photosDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for photos.
• __FLEX_Context_DisplayValue: string
  Title: Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield for photos.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : workers-photos-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• 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
• 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.

{
    "type":"object",
    "properties":{
        "PhotoId":{
            "title":"Photo ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "photosDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-photos-photosDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the image is primary.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhotoType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of photo such as Profile or Cover. Valid values are defined in the commonLookupsLOV.",
            "nullable":true,
            "default":"PROFILE",
            "x-queryable":true
        },
        "Photo":{
            "title":"Photo",
            "type":"string",
            "description":"Unique location of the image. Encrypted version of the file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "PhotoName":{
            "title":"Photo Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the image file.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : photosDFF

Type: array

Show Source

• Array of: object workers-photos-photosDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-photos-photosDFF-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : workers-photos-photosDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Descriptive flexfield for photos.
• __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.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Photo ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield for photos.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

photosDFF

Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF

Parameters:

• PhotoId: $request.path.PhotoId
• workersUniqID: $request.path.workersUniqID

The photosDFF resource is a child of the photos resource. It provides all the photo descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Back to Top

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": [
        {...
           }
   ]
}

Back to Top