Jump to

• Request
• Response
• Examples

Create an additional name

post

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName

Request

Path Parameters

• PartyNumber(required): string
  The unique alternate identifier for the account 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:
  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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

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 associated with the record.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name associated with the record.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name associated with the record.
• Name: string
  Title: Additional Name

  Maximum Length: 360

  The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
• 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.
• PartySourceSystem: string
  The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
• PartySourceSystemReferenceValue: string
  The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
• PreferredFlag: boolean
  Title: Preferred Indicator

  Maximum Length: 1

  Default Value: false

  Identify the name as 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 where the account party is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if the additional name is currently active.
• 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

  TransliterationLanguage 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":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the Additional Name record",
            "nullable":true
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"A professional or family title, such as Don or The Right Honorable",
            "nullable":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"
            }
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the additional name is currently active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"TransliterationLanguage 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"
            }
        },
        "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
        },
        "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
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.",
            "nullable":false,
            "default":false
        }
    }
}

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 : accounts-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 associated with the record.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name associated with the record.
• 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 associated with the record.
• 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 alternate identifier of the party. Inactive records can't be updated.
• PartySourceSystem: string
  The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.
• PartySourceSystemReferenceValue: string
  The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
• PreferredFlag: boolean
  Title: Preferred Indicator

  Maximum Length: 1

  Default Value: false

  Identify the name as 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 where the account party is imported from. The values configured in setup task Trading Community Source System.
• SourceSystemReferenceValue: string
  The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
• StatusFlag: boolean
  Maximum Length: 1

  Default Value: true

  Indicates if the additional name is currently active.
• 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

  TransliterationLanguage 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":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the contact record.",
            "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
        },
        "PartySourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party, associated with the address, is imported from. The values can be configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "NameId":{
            "type":"integer",
            "description":"The unique identifier of the name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "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
        },
        "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
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "StatusFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the additional name is currently active.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account party from the external source system specified in the attribute SourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "TransliterationLanguage":{
            "title":"Transliteration Language",
            "maxLength":"4",
            "type":"string",
            "description":"TransliterationLanguage 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
        },
        "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
        },
        "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
        },
        "PartySourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the party. Inactive records can't be updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "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"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name associated with the record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredFlag":{
            "title":"Preferred Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Identify the name as 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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Links

NameTypeLOV

Operation: /crmRestApi/resources/11.13.18.05/nameAndIdTypes

Parameters:

• finder: NameTypeFinder

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

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

The following properties are defined on the LOV link relation:

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

Back to Top

Examples

The following example shows how to create an additional name by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/100000013637001/child/AdditionalName/

Example of Request Body

The following shows an example of the request body in JSON format.

{   
 "NameType": "LOCAL",
 "Name": "LocalRestName" 
}

Example of Response Body

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

{
"Name": "LocalRestName",
"NameType": "LOCAL",
"NameId": 300100156549375,
"StatusFlag": "A",
"CreationDate": "2017-12-14T14:09:54+00:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2017-12-14T14:09:56.282+00:00",
"LastUpdatedBy": "SALES_ADMIN"
}

Back to Top