1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Additional Names

Get all additional name

get

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

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • NameTypeRF: Finds the additional name by name type.
      Finder Variables:
      • NameType; string; The type of the name. For example, ALIAS or LEGAL.
      • UniqueNameTypeLiteral; string; The unique identifier of the additional name.
    • PrimaryKey: Finds an additional name with the specified primary key.
      Finder Variables:
      • NameId; integer.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AcademicTitle; string; The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.
    • ConflictId; integer; The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
    • CreatedBy; string; The user who created the contact record.
    • CreationDate; string; The date and time when the contact record was created.
    • Description; string; The description of the Additional Name record
    • FirstName; string; The first name associated with the record.
    • LastName; string; The last name associated with the record.
    • LastUpdateDate; string; The date and time when the contact was last updated.
    • LastUpdatedBy; string; The user who last updated the contact record.
    • MiddleName; string; The middle name associated with the record.
    • Name; string; The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
    • NameId; integer; The unique identifier of the name.
    • NameType; string; The type of the name. For example, ALIAS or LEGAL.
    • PartyId; integer; The unique identifier of the party.
    • PartyNumber; string; The alternate identifier of the party. Inactive records can't be updated.
    • PreferredFlag; boolean; Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'.
    • StatusFlag; boolean; Indicates if the additional name is currently active.
    • Title; string; A professional or family title, such as Don or The Right Honorable
    • TransliterationLanguage; string; TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accounts-AdditionalName-item-response
Type: object
Show Source
  • Title: Academic Title
    Maximum Length: 30
    The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.
  • Default Value: 0
    The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
  • Read Only: true
    Maximum Length: 64
    The user who created the contact record.
  • Read Only: true
    The date and time when the contact record was created.
  • Title: Description
    Maximum Length: 240
    The description of the Additional Name record
  • Title: First Name
    Maximum Length: 150
    The first name associated with the record.
  • Title: Last Name
    Maximum Length: 150
    The last name associated with the record.
  • Read Only: true
    The date and time when the contact was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the contact record.
  • Links
  • Title: Middle Name
    Maximum Length: 60
    The middle name associated with the record.
  • Title: Additional Name
    Maximum Length: 360
    The name of the organization, person, or group party. For example, "Oracle" or "John Smith".
  • Read Only: true
    The unique identifier of the name.
  • Title: Additional Name Type
    Maximum Length: 30
    The type of the name. For example, ALIAS or LEGAL.
  • The unique identifier of the party.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The alternate identifier of the party. Inactive records can't be updated.
  • 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.
  • The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
  • 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'.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
  • The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
  • Maximum Length: 1
    Default Value: true
    Indicates if the additional name is currently active.
  • Title: Title
    Maximum Length: 60
    A professional or family title, such as Don or The Right Honorable
  • 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.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-AdditionalName-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function associated with the smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    Indicates whether the action is seeded or custom.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-AdditionalName-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : accounts-AdditionalName-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : accounts-AdditionalName-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Back to Top

Examples

The following example shows how to get all additional names by submitting a GET request on the REST resource using cURL.

cURL Command

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

Example of Response Body

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

{
  "items" : [ {
  "Name": "LocalRestName2",
"NameType": "LOCAL",
"NameId": 300100156549400,
"StatusFlag": "A",
"CreationDate": "2017-12-14T14:12:48+00:00",
"CreatedBy": "SALES_ADMIN",
"LastUpdateDate": "2017-12-14T14:12:48.098+00:00",
"LastUpdatedBy": "SALES_ADMIN"
    }, 
	{
   "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"
     }
	 ],
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  ...
  }
Back to Top