Jump to

• Request
• Response

Update an additional name

patch

/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/AdditionalName/{NameId}

Request

Path Parameters

• NameId(required): integer(int64)
  The unique identifier of the name.
• PartyNumber(required): string
  The unique alternate identifier for the organization party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

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

• AcademicTitle: string
  Title: Academic Title

  Maximum Length: 30

  The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the Additional Name record.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name in the additional name (Not Applicable).
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name in the additional name (Not Applicable).
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name in the additional name (Not Applicable).
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
• PartySourceSystem: string
  The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
• PartySourceSystemReferenceValue: string
  The identifier for the record from an external source system.
• PreferredFlag: boolean
  Title: Preferred Indicator

  Maximum Length: 1

  Default Value: false

  Indicates the preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.
• SourceSystem: string
  The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
• SourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The status of the additional name, used for soft delete.
• Title: string
  Title: Title

  Maximum Length: 60

  A professional or family title, such as Don or The Right Honorable.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  The transliteration language attribute helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.

{
    "type":"object",
    "properties":{
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the Additional Name record.",
            "nullable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "Name":{
            "title":"Additional Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the organization, person, or group party. For example, \"Oracle\" or \"John Smith\".",
            "nullable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system of the account, contact or household with which the address is associated.  Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The status of the additional name, used for soft delete.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable.",
            "nullable":true
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":4,
            "type":"string",
            "description":"The transliteration language attribute helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : hubOrganizations-AdditionalName-item-response

Type: object

Show Source

• AcademicTitle: string
  Title: Academic Title

  Maximum Length: 30

  The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the contact record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the contact record was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the Additional Name record.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name in the additional name (Not Applicable).
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name in the additional name (Not Applicable).
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the contact was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the contact record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name in the additional name (Not Applicable).
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
• NameId: integer (int64)
  Read Only: true

  The unique identifier of the name.
• NameType: string
  Title: Additional Name Type

  Maximum Length: 30

  The type of the name. For example, ALIAS or LEGAL.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The party number. Inactive records can't be updated.
• PartySourceSystem: string
  The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
• PartySourceSystemReferenceValue: string
  The identifier for the record from an external source system.
• PreferredFlag: boolean
  Title: Preferred Indicator

  Maximum Length: 1

  Default Value: false

  Indicates the preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.
• SourceSystem: string
  The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
• SourceSystemReferenceValue: string
  The unique identifier of the relationship from external source system.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  The status of the additional name, used for soft delete.
• Title: string
  Title: Title

  Maximum Length: 60

  A professional or family title, such as Don or The Right Honorable.
• TransliterationLanguage: string
  Title: Transliteration Language

  Maximum Length: 4

  The transliteration language attribute helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.

{
    "type":"object",
    "properties":{
        "AcademicTitle":{
            "title":"Academic Title",
            "maxLength":30,
            "type":"string",
            "description":"The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the Additional Name record.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name in the additional name (Not Applicable).",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Additional Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the organization, person, or group party. For example, \"Oracle\" or \"John Smith\".",
            "nullable":true,
            "x-queryable":true
        },
        "NameId":{
            "type":"integer",
            "description":"The unique identifier of the name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NameType":{
            "title":"Additional Name Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the name. For example, ALIAS or LEGAL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The party number. Inactive records can't be updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system of the account, contact or household with which the address is associated.  Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":false
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The identifier for the record from an external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "StatusFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The status of the additional name, used for soft delete.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable.",
            "nullable":true,
            "x-queryable":true
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":4,
            "type":"string",
            "description":"The transliteration language attribute helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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"
    }
}

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

Links

NameTypeLOV

Operation: /crmRestApi/resources/11.13.18.05/nameAndIdTypes

Parameters:

• finder: NameTypeFinder%3BBindTypeOfParty%3D{PartyType}

The list of values indicating the name types.

The following properties are defined on the LOV link relation:

• Source Attribute: NameType; Target Attribute: TypeCode
• Display Attribute: TypeName

StatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_STATUS

This list of values indicating the status.

The following properties are defined on the LOV link relation:

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

TransliterationLanguageLOV

Operation: /fscmRestApi/resources/11.13.18.05/languagesLOV

This list of values indicating the language.

The following properties are defined on the LOV link relation:

• Source Attribute: TransliterationLanguage; Target Attribute: LanguageCode
• Display Attribute: Description

Back to Top