Jump to

• Request
• Response
• Examples

Update a worker communication account

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}

Request

Path Parameters

• DeliveryMethodId(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: string
  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: string
  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

• AccountName: string
  Title: Account Name

  Maximum Length: 1000

  Name of the account.
• EndDate: string (date)
  Title: To Date

  End date of the account.
• 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.
• StartDate: string (date)
  Title: From Date

  Start date of the account.

{
    "type":"object",
    "properties":{
        "AccountName":{
            "title":"Account Name",
            "maxLength":1000,
            "type":"string",
            "description":"Name of the account.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"End date of the account.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Provider":{
            "title":"Provider",
            "maxLength":30,
            "type":"string",
            "description":"Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"Start date of the account.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "otherCommunicationAccountsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : otherCommunicationAccountsDFF

Type: array

Show Source

• Array of: object workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : workers-otherCommunicationAccounts-item-response

Type: object

Show Source

• AccountName: string
  Title: Account Name

  Maximum Length: 1000

  Name of the account.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the communication account information.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the communication account information was created.
• DeliveryMethodId: integer (int64)
  Title: Delivery Method ID

  Read Only: true

  Surrogate identifier for the delivery method.
• EndDate: string (date)
  Title: To Date

  End date of the account.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the communication account information was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the 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 person's provider type.
• StartDate: string (date)
  Title: From Date

  Start date of the account.

{
    "type":"object",
    "properties":{
        "AccountName":{
            "title":"Account Name",
            "maxLength":1000,
            "type":"string",
            "description":"Name of the account.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the communication account information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the communication account information was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DeliveryMethodId":{
            "title":"Delivery Method ID",
            "type":"integer",
            "description":"Surrogate identifier for the delivery method.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"End date of the account.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the communication account information was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the communication account information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Provider":{
            "title":"Provider",
            "maxLength":30,
            "type":"string",
            "description":"Provider of the account such as Facebook and Twitter. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ProviderMeaning":{
            "title":"Provider",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the person's provider type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"Start date of the account.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "otherCommunicationAccountsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

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

Type: array

Show Source

• Array of: object workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-otherCommunicationAccounts-otherCommunicationAccountsDFF-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-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30

  Context Value
• __FLEX_Context_DisplayValue: string
  Title: Context Value

  Context Value
• DeliveryMethodId: integer (int64)
  Title: Delivery Method ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DeliveryMethodId":{
            "title":"Delivery Method ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":30,
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Value"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "description":"Context Value",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Value"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

otherCommunicationAccountsDFF

Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF

Parameters:

• DeliveryMethodId: $request.path.DeliveryMethodId
• workersUniqID: $request.path.workersUniqID

providersLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPER_CM_MTHD

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.

Back to Top

Examples

The following example shows how to update a worker communication account 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 "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/otherCommunicationAccounts/300100187109866"

Example of Payload

The following is an example of the payload.

{
"AccountName": "[e-mail]"
}

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.

{
    "DeliveryMethodId": 300100187109866,
    "Provider": "FACE",
    "AccountName": "[e-mail]",
    "StartDate": "2019-05-16",
    "EndDate": null,
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-05-16T12:48:22+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-05-16T12:52:59+00:00",
    "links": [
        {...
           }
   ]
}

Back to Top