Jump to

• Request
• Response

Update a communication account

patch

/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/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=
• hcmContactsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the HCM Contacts resource and used to uniquely identify an instance of HCM Contacts. The client should not generate the hash key value. Instead, the client should query on the HCM Contacts collection resource in order to navigate to a specific instance of HCM Contacts 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 contact's communication account.
• EndDate: string (date)
  Title: To Date

  End date of the contact's communication 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 contact's communication account.

{
    "type":"object",
    "properties":{
        "AccountName":{
            "title":"Account Name",
            "maxLength":1000,
            "type":"string",
            "description":"Name of the contact's communication account.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"End date of the contact's communication 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 contact's communication account.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "otherCommunicationAccountsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/hcmContacts-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : otherCommunicationAccountsDFF

Type: array

Show Source

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

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

Nested Schema : hcmContacts-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 : hcmContacts-otherCommunicationAccounts-item-response

Type: object

Show Source

• AccountName: string
  Title: Account Name

  Maximum Length: 1000

  Name of the contact's communication account.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

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

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Start date of the contact's communication account.

{
    "type":"object",
    "properties":{
        "AccountName":{
            "title":"Account Name",
            "maxLength":1000,
            "type":"string",
            "description":"Name of the contact's communication account.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the contact's 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 contact's 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 contact's 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 contact's communication 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 contact's 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 contact's 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 contact's provider type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"Start date of the contact's communication 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/hcmContacts-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 hcmContacts-otherCommunicationAccounts-otherCommunicationAccountsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hcmContacts-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 : hcmContacts-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/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF

Parameters:

• DeliveryMethodId: $request.path.DeliveryMethodId
• hcmContactsUniqID: $request.path.hcmContactsUniqID

providersLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPER_CM_MTHD

The following properties are defined on the LOV link relation:

• Source Attribute: Provider; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top