Get a person
get
/crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}
Request
Path Parameters
-
PartyNumber(required): string
The unique alternate identifier for the person 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
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : hubPersons-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes their academic qualification, such as Dr. Jane Smith. -
AdditionalIdentifier: array
Additional Identifiers
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. -
AdditionalName: array
Additional Names
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with a person. The resource allows you to capture other names associated with a person such as a maiden name, or a brand name. -
Address: array
Addresses
Title:
Addresses
The addresses resource is used to view, create, update, and delete an address, It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of address. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate unique identifier for the address. One of AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressType: string
The additional information as type of address like BillTo, ShipTo.
-
Attachment: array
Attachments
Title:
Attachments
The person attachments resource is used to view, create, update, and delete attachments of a person. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of the person. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The reason for the person's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of address. -
CleanlinessScore: integer
(int64)
Title:
Cleanliness
The overall score for the contact / account record for category = Cleanliness. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the person. -
CompletenessScore: integer
(int64)
Title:
Completeness
Overall score for the contact / account record for category = Completeness. -
ContactPoint: array
Contact Points
Title:
Contact Points
The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The contact point describes the types of contact points. For example, phone, email, or web. -
ContactRole: string
Title:
Contact Role
Maximum Length:60
The name of the role of the contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code used by the CRM Extensibility framework. It is defaulted to the value set in the profile option ZCA_COMMON_CORPORATE_CURRENCY. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the person record. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the person record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerClassification: array
Customer Classifications
Title:
Customer Classifications
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household. -
DataCloudStatus: string
Title:
Enrichment Status
Maximum Length:30
The enrichment status of the contact record from Data-as-a-Service. A list of valid values are defined in the lookup DATA_CLOUD_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
DataConfidenceScore: integer
(int64)
Title:
Data Confidence
The overall data confidence score that indicates the level of data quality for a particular record. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
Department: string
Title:
Department
Maximum Length:60
The name the department of the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates whether the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Maximum Length:1
Indicates whether the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Maximum Length:1
Indicates whether the user can e-mail the person or not. If the value is True, then the user must not contact the person by e-mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotMailFlag: boolean
Title:
Do Not Mail
Maximum Length:1
Indicates whether the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DuplicateIndicator: string
Title:
Duplicate Type
Maximum Length:30
The duplicate status of the record in certain scenarios. -
DuplicateScore: integer
(int64)
Title:
Duplication
The overall score for the contact / account record for category = Duplicate. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the person. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
The date when email address was last verified. -
EmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email. -
EnrichmentScore: integer
(int64)
Title:
Enrichment
The overall score for the contact / account record for category = Enrichment. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
HeadOfHouseholdFlag: boolean
Title:
Head of Household Indicator
Maximum Length:1
Default Value:false
Indicates if the person is the head of the household. If the value is True, then the person is the head of the household. The default value is False. -
HomePhoneVerificationDate: string
(date)
Title:
Home Phone Verification Date
The date when home phone number was last verified. -
HomePhoneVerificationStatus: string
Title:
Home Phone Verification Status
Maximum Length:30
The status code of the home phone number verification. The values based on lookup are valid and invalid for phone. -
HouseholdIncomeAmount: number
Title:
Household Income
The income of the household that this person is a part of. -
HouseholdSize: number
Title:
Household Size
The size of the household this person is a part of. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title of the contact, for example, Analyst. A list of valid values is defined in the lookup HZLookup. -
LastContactDate: string
(date-time)
Title:
Last Contact Date
The date when the contact was last contacted. -
LastEnrichmentDate: string
(date)
Title:
Last Enrichment Date
The date when the record was last enriched. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as Fon, or Van. For example, if a person???s name is Hans Van, the last name of the person is captured using this attribute. -
LastScoreUpdateDate: string
(date-time)
Title:
Last Score Date
Indicates when the last data confidence score on this record was computed. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobilePhoneVerificationDate: string
(date)
Title:
Mobile Verification Date
The date when mobile phone number was last verified. -
MobilePhoneVerificationStatus: string
Title:
Mobile Verification Status
Maximum Length:30
The status code of the mobile phone number verification. The values based on lookup are valid and invalid for phone. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The system generated or manually overridden suffix. The suffix is used to generate the PartyUniqueName attribute and is concatenated to the ContactName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. -
Note: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete a note. A note data object captures comments, information, or instructions for an Oracle Fusion Applications business object. -
OrganizationPartyId: integer
(int64)
Title:
Primary Organization Party ID
The unique identifier of primary organization that this person belongs to. To specify the primary organization for a person you can provide an Organization's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
OrganizationPartyName: string
Title:
Primary Organization Party Name
Read Only:true
Maximum Length:360
The organization name of the primary organization that this person belongs to. This is a read only attribute. -
OrganizationPartyNumber: string
Title:
Primary Organization Party Number
Read Only:true
Maximum Length:30
The party number of the primary organization that this person belongs to. To specify the primary organization for a person you can provide an Organization's party ID, PartyNumber, SourceSystem or SourceSystemReference. -
OrganizationSourceSystem: string
Title:
Primary Organization Party Source System
The source system code of the primary organization that this person belongs to. To specify the primary organization for a person you can provide an Organization's party ID, PartyNumber, SourceSystem or SourceSystemReference. -
OrganizationSourceSystemReferenceValue: string
Title:
Primary Organization Party Source System Reference
The source system reference value of the primary organization that this person belongs to. To specify the primary organization for a person you can provide an Organization's party ID, PartyNumber, SourceSystem or SourceSystemReference. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the person. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier for the person 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. -
PartyUsageCode: string
Title:
Party Usage Code
The party usage code for this person. -
PersonalIncomeAmount: number
Title:
Annual Income
The estimated gross annual income of the person. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:450
The derived name of the person. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
Four digit extension to the United States Postal ZIP code. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred contact method of the person. The accepted values are defined in the lookup type HZ_PREFERRED_CONTACT_METHOD. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The code indicating the person's default currency. A list of valid currency codes are defined during the application setup. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
Province: string
Title:
Province
Maximum Length:60
The province element of address. -
RawHomePhoneNumber: string
Title:
Raw Home Phone Number
Maximum Length:60
The unformatted home phone number of the person. -
RawMobilePhoneNumber: string
Title:
Raw Mobile Number
Maximum Length:60
The unformatted mobile phone number of the person. -
RawWorkPhoneNumber: string
Title:
Raw Work Phone Number
Maximum Length:60
The unformatted work phone number of the person. -
RecencyScore: integer
(int64)
Title:
Recency
The overall score for the contact / account record for category = Recency. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The code indicating the registration status of the person. For example, Approved, Pending, or Rejected. The valid list of values is defined in the lookup ORA_CONTACT_REG_STATUS. -
Relationship: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between two entities such as account, contact, and household. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease are defined in the lookup OWN_RENT_IND. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SalutoryIntroduction: string
Title:
Prefix
Maximum Length:30
The title or a salutary introduction for a contact, such as Mr., Herr, and so on. A list of accepted values is defined in the lookup CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SourceSystem: string
Title:
Source System
Maximum Length:255
The name of external source system where the person party is imported from. The values configured in setup task Trading Community Source System. -
SourceSystemReference: array
Source System References
Title:
Source System References
The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry. -
SourceSystemReferenceValue: string
Title:
Source System Reference
Maximum Length:255
The unique identifier for the person party from the external source system specified in the attribute SourceSystem. -
State: string
Title:
State
Maximum Length:60
The state element of address. -
Status: string
Title:
Status
Read Only:true
Maximum Length:1
Default Value:A
The status of the person. This is an internally-used column and the values are defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification Number
Maximum Length:20
The taxpayer identification number that is often a unique identifier of the person such as income taxpayer Id in USA and fiscal code or NIF in Europe. -
ThirdPartyFlag: boolean
Title:
Third Party Indicator
Maximum Length:1
Indicate whether the person was a third party. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone where the person is located. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
UniqueNameSuffix: string
Title:
Name Suffix
Maximum Length:540
The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the PersonName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. -
UsageAssignment: array
Usage Assignments
Title:
Usage Assignments
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Indicates whether the person was validated. -
ValidityScore: integer
(int64)
Title:
Validity
The overall score for the contact / account record for category = Validity. -
WorkPhoneVerificationDate: string
(date)
Title:
Work Phone Verification Date
The date when work phone number was last verified. -
WorkPhoneVerificationStatus: string
Title:
Work Phone Verification Status
Maximum Length:30
The status code of the work phone number verification. The values based on lookup are valid and invalid for phone.
Nested Schema : Additional Identifiers
Type:
array
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with a person. The resource allows you to capture other names associated with a person such as a maiden name, or a brand name.
Show Source
Nested Schema : Addresses
Type:
array
Title:
Addresses
The addresses resource is used to view, create, update, and delete an address, It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The person attachments resource is used to view, create, update, and delete attachments of a person.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The contact point describes the types of contact points. For example, phone, email, or web.
Show Source
Nested Schema : Customer Classifications
Type:
array
Title:
Customer Classifications
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete a note. A note data object captures comments, information, or instructions for an Oracle Fusion Applications business object.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between two entities such as account, contact, and household.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry.
Show Source
Nested Schema : Usage Assignments
Type:
array
Title:
Usage Assignments
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member.
Show Source
Nested Schema : hubPersons-AdditionalIdentifier-item-response
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. It is used to review the list of country codes using the Manage Geographies task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the additional identifier. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. The default value is HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Read Only:
true
The date when the additional identifier was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the additional identifier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the additional identifier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the additional identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of party identifier. -
PartyIdentifierValue: string
Title:
Identifier Value
Maximum Length:60
The value of the party identifier. -
PartyNumber: string
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.
-
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.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : hubPersons-AdditionalName-item-response
Type:
Show Source
object
-
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 of the person (Not Applicable). -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person (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 of the person (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
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, 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
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US, NL, DK etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-Address-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressId: integer
(int64)
Read Only:
true
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate unique identifier for the address. One of AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressType: string
Title:
Type
The type of address. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city element of Address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The common Language Location Identifier (CLLI) code. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the addresses. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. This attribute is used by CRM Extensibility framework. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. -
County: string
Title:
County
Maximum Length:60
The county element of address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code related to the address. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date on which the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates that this address should not be used for mailing. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The effective date of the address.
-
EndDateActive: string
(date)
Title:
End Date
The date after which this address is rendered inactive. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address information. -
FormattedAddress1: string
Title:
Formatted Address 1
Read Only:true
The formatted address information. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
FormattedMultilineAddress1: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
HouseType: string
Title:
House Type
Maximum Length:30
Indicates the building type. A list of valid values is defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the contact record. -
Latitude: number
Title:
Latitude
The attribute is used to store latitude information for the location for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location record for this address. -
Longitude: number
Title:
Longitude
The attribute is used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ObjectVersionNumber1: integer
(int32)
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact, or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact or household record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the account, contact, or household to which the address is associated. 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 default value is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. The value is updateable depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of valid values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
The user defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
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
Title:
Party Source System Reference Value
Identifier from external source system for the account, contact or household with which the address is associated. Part of Alternate Key (along with PartySourceSystem) . 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. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if this is the primary address of the associated object. Accepts values Y for primary contact, N for all others. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. 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. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
The name of the table that holds the record data and is referenced to manage source system reference. -
SSRPartyOwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the party record data and is referenced to manage source system reference. -
StartDateActive: string
(date)
Title:
Start Date
The date from which this address is active. Defaulted to the current system date if not provided during create. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
An internal application determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location was validated. Y for validated, N for invalidated. If the value is True, then the location is validated. The value is internally set by system during address cleansing. -
ValidationStartDate: string
(date)
Read Only:
true
The date on which the validation starts. Internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The standardized status code that describes the results of the validation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-ContactPoint-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The unique identifier of the conflict. -
ContactPointId: integer
(int64)
Title:
Contact Point ID
Read Only:true
The unique identifier of the contact point. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of contact point. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. -
DoNotContactPreferenceFlag: boolean
Title:
Do Not Contact
The contact preference flag that indicates DNC option. -
DoNotContactReason: string
Title:
Do Not Contact Reason
The reason code for the contact preference. -
EmailAddress: string
Title:
Email
Maximum Length:255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email. -
FormattedPhoneNumber: string
Title:
Phone Number
Read Only:true
Maximum Length:255
The formatted phone number of the contact point. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the contact point was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the contact point. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the party. -
PartyNumber: string
Title:
Registry ID
The party number. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
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
Title:
Party Source System Reference Value
The unique identifier of the relationship from external source system. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:255
The area code for the telephone number. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:255
The country code of the phone number. -
PhoneExtension: string
Title:
Extension
Maximum Length:255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Title:
Phone
Maximum Length:255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. Sample values are ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS etc. -
PhoneType: string
Title:
Type
The type of the phone. -
PreferenceRequestedBy: string
Title:
Preference Requested By
Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Title:
Phone
Maximum Length:255
The phone number in raw format. -
SocialNetworkId: string
Title:
User ID
The unique identifier for the social network. -
SocialNetworkName: string
Title:
Social Network
The social network type. -
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. Sample values ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS etc. -
SourceSystem: string
Title:
Source System
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
Title:
Source System Reference Value
The unique identifier for the accounts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update. -
Status: string
Title:
Status
Maximum Length:30
Default Value:A
The status of the contact point. -
URL: string
Title:
URL
The URL associated with the contact point. -
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values are not verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB. Sample values are HOMEPAGE, SALESURL, MARKETINGURL, SUPPORTURL, RSS_FEED etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
A valid classification code corresponding to the classification category. -
ClassCodeMeaning: string
Title:
Classification Code Meaning
Read Only:true
Maximum Length:80
A valid classification code meaning corresponding to the classification code. -
CodeAssignmentId: integer
(int64)
Title:
Code Assignment ID
Read Only:true
The unique identifier for the customer classification assignment. -
ConflictId: integer
(int64)
Read Only:
true
Default Value:0
The unique identifier of the conflict. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the record. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application or module that created the record. The default value is HZ_WS for all web service based creation. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Indicates the date and time when the record is created. -
EndDateActive: string
(date)
Title:
End Date
The date on which the classification code is no longer valid. -
IsAuxClassificationFlag: boolean
Title:
Auxiliary Classification Status
Read Only:true
Indicates whether the classification category is a custom group classification category. -
IsIndustryFlag: boolean
Title:
Industry Type Status
Read Only:true
Indicates whether the classification category is an industry group classification category. -
IsOrgTypeFlag: boolean
Title:
Organization Type Status
Read Only:true
Indicates whether the classification category is an organization type classification category. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates the date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of account, contact, or household to which the classification category and classification code is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household to which the classification category and classification code is associated. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification category and classification code is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier from external source system for the account, contact, or household with which the classification category and classification code is associated. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
Indicates the type of the party, such as account, contact, or household. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicator to show if the current code is the primary classification code. -
SourceSystem: string
Title:
Source System
The name of external source system for the class category denoted by a code, which is defined by an administrator as part of system setup. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the class category from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify a class category. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the classification becomes valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates if the code assignment is active or inactive, such as A for active and I for inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency associated with the note. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the creator party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code related to the note. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the record. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the note. -
NoteNumber: string
Maximum Length:
30
The system generated or can come from external system (user key). -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
NoteTxt: string
(byte)
Title:
Note
The column that stores the actual text of the note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of the party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The source_object_code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The source_object_Uid for the source object (such as Activities, Opportunities etc.) as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user has access to update the record. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The attribute to specify the visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-Relationship-item-response
Type:
Show Source
object
-
BackwardRole: string
Title:
Backward Role
Read Only:true
The backward relationship code used to describe relationships. For example, SUPPLIER_OF. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for this relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
DirectionCode: string
Read Only:
true
Maximum Length:30
The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the contact record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectPartyId: integer
(int64)
The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
-
ObjectPartyName: string
Title:
Object Party Name
Read Only:true
Maximum Length:360
The name of the object party of the relationship. -
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of external source system for the object party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. 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. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
ObjectTableName: string
Maximum Length:
30
The source table name of the object party in this relationship. -
ObjectType: string
Maximum Length:
30
The object type of the contact. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyId1: integer
(int64)
Read Only:
true
The alternate unique identifier of the party. -
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
Indicates whether this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RelationshipId: integer
(int64)
Read Only:
true
The unique identifier of the relationship. -
RelationshipRecId: integer
(int64)
The unique identifier of the relationship record.
-
RelationshipSourceSystem: string
The name of external source system for the relationship, which is defined by an admin as part of the system setup.
-
RelationshipSourceSystemReferenceValue: string
The identifier for the relationship with the external source system.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The relationship type name. For example, CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups. -
RequestId: integer
(int64)
The unique identifier of the request.
-
Role: string
Title:
Role
The role between the subject and object party. -
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the record data and is referenced to manage source system reference. -
StartDate: string
(date)
Title:
From Date
The date when the relationship was established. Defaulted to the system date. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
Indicates whether this is an active or inactive relationship. A for active, I for inactive. This is an internal column and you are not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SubjectPartyId: integer
(int64)
The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
-
SubjectPartyName: string
Title:
Subject Party Name
Read Only:true
Maximum Length:360
The name of the subject party. -
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of external source system for the subject party in the relationship, which are defined by an admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. 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. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
SubjectTableName: string
Maximum Length:
30
The source table of the subject. -
SubjectType: string
Maximum Length:
30
The subject type of the contact. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-SourceSystemReference-item-response
Type:
Show Source
object
-
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 row. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDate: string
(date)
The end date of the record.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the account, contact, or household.
-
PartyNumber: string
Title:
Party Number
The public unique Identifier of the account, contact, or household. Inactive records can't be updated. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the account, contact, and household. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The source system name. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The sequentially generated identifier. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system id for the source system logical entity. -
StartDate: string
(date)
The start date of the source system.
-
Status: string
Maximum Length:
1
Default Value:A
The status of the reference. A for Active. Mapping is invalid. The for Inactive. Mapping is invalid. The default is A for Active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hubPersons-UsageAssignment-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments of the usage assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreatedByModule: string
Maximum Length:
30
Default Value:ORA_ZCH_WS
The user who created the module. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
EndDate: string
(date)
Title:
To Date
Indicates the date at the end of the date range within which the row is effective. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of party that the party usage is assigned to. -
PartyUsageAssignmentId: integer
(int64)
Read Only:
true
The unique identifier for a party usage assignment. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The unique identifier of party usage assigned to the party. -
StartDate: string
(date)
Title:
From Date
Indicates the date at the beginning of the date range within which the row is effective. -
StatusFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:true
The internal use to soft delete 'from' assignment in transition rule. Assignment API won't expose this column. However, any query on assignment table should have status_flag = 'A'.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AdditionalIdentifier
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. - PartyNumber:
- AdditionalName
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The additional name resource is used to view, create, update, and delete additional names associated with a person. The resource allows you to capture other names associated with a person such as a maiden name, or a brand name. - PartyNumber:
- Address
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The addresses resource is used to view, create, update, and delete an address, It is an object that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household. - PartyNumber:
- Attachment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The person attachments resource is used to view, create, update, and delete attachments of a person. - PartyNumber:
- CertificationLevelLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_PARTY_CERT_LEVEL
The list of values indicating the certification level of the person such as Minimum or Highest.
The following properties are defined on the LOV link relation:- Source Attribute: CertificationLevel; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CertificationReasonCodeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_PARTY_CERT_REASON
The list of values indicating the current certification level assignment of the person such as Manual or Third-Party.
The following properties are defined on the LOV link relation:- Source Attribute: CertificationReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContactPoint
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The contact points resource is used to view, create, update, and delete a contact point. It is an object that includes attributes used to store values while creating or updating the contact point. The contact point describes the types of contact points. For example, phone, email, or web. - PartyNumber:
- ContactRoleLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_HZ_CONTACT_ROLE
The list of values indicating the different roles of the person such as Service contact.
The following properties are defined on the LOV link relation:- Source Attribute: ContactRole; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteFlagFinder%3BBindObsoleteFlag%3DN
The list of values indicating the country of the address, such as US and UK.
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryCode
- Display Attribute: TerritoryShortName
- finder:
- CurrenciesLOV
-
Parameters:
- finder:
EnabledFlagFinder%3BBindEnabledFlag%3DY
The list of values indicating the default currency used by the person, such as USD or GBP.
The following properties are defined on the LOV link relation:- Source Attribute: PreferredFunctionalCurrency; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode, Name
- finder:
- CustomerClassification
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The customer classifications resource is used to view, create, update, and delete a customer classification. It is an object that includes attributes used to store values while creating or updating a code assignment. A code assignment represents the classification category and classification code information of an account, contact, or household. - PartyNumber:
- DataCloudStatusLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DDATA_CLOUD_STATUS
The list of values indicating the enrichment status of the person record, such as Enriched, Deleted, or Matched.
The following properties are defined on the LOV link relation:- Source Attribute: DataCloudStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DepartmentCodeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DDEPARTMENT_TYPE
The list of values indicating the department which the person belongs to, such as Accounting and Consulting.
The following properties are defined on the LOV link relation:- Source Attribute: DepartmentCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- EmailVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: EmailVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- GenderLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_GENDER
The list of values indicating the gender of the person, such as Male or Female.
The following properties are defined on the LOV link relation:- Source Attribute: Gender; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- HomePhoneVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: HomePhoneVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- JobTitleCodeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DRESPONSIBILITY
The list of values indicating the job title of the person.
The following properties are defined on the LOV link relation:- Source Attribute: JobTitleCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MaritalStatusLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DMARITAL_STATUS
The list of values indicating the marital status of the person, such as Married or Single.
The following properties are defined on the LOV link relation:- Source Attribute: MaritalStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MobilePhoneVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: MobilePhoneVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Note
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The notes resource is used to view, create, update, and delete a note. A note data object captures comments, information, or instructions for an Oracle Fusion Applications business object. - PartyNumber:
- PartyUsageLOV
-
Parameters:
- finder:
PersonPartyUsageRowFinder
The list of values indicating the party usage codes that can be assigned to the person.
The following properties are defined on the LOV link relation:- Source Attribute: PartyUsageCode; Target Attribute: PartyUsageCode
- Display Attribute: PartyUsageCode
- finder:
- PreferredContactMethodLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_PREFERRED_CONTACT_METHOD
The list of values indicating the preferred contact method of the person, such as mail and phone.
The following properties are defined on the LOV link relation:- Source Attribute: PreferredContactMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrenciesLOV
-
The list of values indicating the currency code used by the person such as USD and GBP.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: Name
- RegistrationStatusLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_CONTACT_REG_STATUS
The list of values indicating the registration status of the person, such as Pending and Approved.
The following properties are defined on the LOV link relation:- Source Attribute: RegistrationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Relationship
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The relationships resource is used to view, create, update, and delete a relationship. It is an object that includes attributes used to store values while creating or updating a relationship. This object stores attributes that define and categorizes a relationship between two entities such as account, contact, and household. - PartyNumber:
- RentOwnIndLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DOWN_RENT_IND
The list of values indicating whether the person's property is owned or rented.
The following properties are defined on the LOV link relation:- Source Attribute: RentOrOwnIndicator; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesAffinityCodeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE
The list of values indicating the affinity of the person to the deploying person, such as neutral and favorable.
The following properties are defined on the LOV link relation:- Source Attribute: SalesAffinityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesBuyingRoleCodeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
The list of values indicating the role played by the person in the buying process, such as Support role and Key decision maker.
The following properties are defined on the LOV link relation:- Source Attribute: SalesBuyingRoleCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalutoryIntroductionLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DCONTACT_TITLE
The list of values indicating the title or the salutary introduction for a person, such as Mr., Mrs., or Dr..
The following properties are defined on the LOV link relation:- Source Attribute: SalutoryIntroduction; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SourceSystemReference
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The source system references resource is used to view, create, update, and delete a source system reference. It is an external system from which data can be imported into the trading community registry. - PartyNumber:
- StatusLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DHZ_STATUS
The list of values indicating the status.
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TimezoneCodeLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_HZ_TIMEZONE_CODES
The list of values indicating different time zones.
The following properties are defined on the LOV link relation:- Source Attribute: TimezoneCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- UsageAssignment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
The party usage assignments resource is used to view, create, update, and delete a party usage assignment. It is the party usage assignment associated with a trading community member. - PartyNumber:
- WorkPhoneVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder
The following properties are defined on the LOV link relation:- Source Attribute: WorkPhoneVerificationStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get a person by submitting a GET request on the REST resource.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798 \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PartyId": 300100015782193, "PartyNumber": "CDRM_7798", "PersonName": "Alise ZHRX-AU-W-1HSB14", "UniqueNameSuffix": null, "Status": "A", "CreatedByModule": "PERSON_USER_SERVICE", "CreatedBy": "FUSION_APPS_CRM_SOA_APPID", "CreationDate": "2012-12-27T01:03:55.055+00:00", "LastUpdateDate": "2013-01-01T18:29:15.025+00:00", "LastUpdatedBy": "FUSION_APPS_CRM_SOA_APPID", "ThirdPartyFlag": null, "ValidatedFlag": null, "AcademicTitle": null, "CertificationLevel": null, "CertificationReasonCode": null, "Comments": null, "ContactRole": null, "CorpCurrencyCode": null, "CurcyConvRateType": null, "CurrencyCode": null, "DataCloudStatus": null, "DateOfBirth": null, "DateOfDeath": null, "DeceasedFlag": false, "DeclaredEthnicity": null, "Department": null, "DepartmentCode": null, "DoNotCallFlag": false, "DoNotContactFlag": false, "DoNotEmailFlag": false, "DoNotMailFlag": false, "FirstName": "Alise", "Gender": null, "HeadOfHouseholdFlag": null, "HouseholdIncomeAmount": null, "HouseholdSize": null, "Initials": null, "TaxpayerIdentificationNumber": null, "JobTitle": null, "JobTitleCode": null, "LastContactDate": null, "LastEnrichmentDate": null, "LastName": "ZHRX-AU-W-1HSB14", "LastNamePrefix": null, "MaritalStatus": null, "MaritalStatusEffectiveDate": null, "MiddleName": null, "NameSuffix": null, "PersonalIncomeAmount": null, "Title": "MS.", "PlaceOfBirth": null, "PreviousLastName": null, "PreferredContactMethod": null, "PreferredFunctionalCurrency": null, "RegistrationStatus": null, "RentOrOwnIndicator": null, "SalesAffinityCode": null, "SalesBuyingRoleCode": null, "Salutation": null, "SalutoryIntroduction": null, "SecondLastName": null, "DataConfidenceScore": null, "LastScoreUpdateDate": null, "DuplicateIndicator": null, "CompletenessScore": null, "ValidityScore": null, "EnrichmentScore": null, "RecencyScore": null, "CleanlinessScore": null, "DuplicateScore": null, "TimezoneCode": null, "OrganizationPartyId": null, "AddressElementAttribute1": null, "AddressElementAttribute2": null, "AddressElementAttribute3": null, "AddressElementAttribute4": null, "AddressElementAttribute5": null, "Address1": null, "Address2": null, "Address3": null, "Address4": null, "AddressLinesPhonetic": null, "Building": null, "City": null, "Country": null, "County": null, "FloorNumber": null, "PostalCode": null, "PostalPlus4Code": null, "Province": null, "State": null, "AddressNumber": null, "Mailstop": null, "SourceSystem": "FUSION_HCM", "SourceSystemReferenceValue": "300100015960766", "AddressType": null, "PartyUsageCode": "HR_EMPLOYEE", "RawHomePhoneNumber": null, "HomePhoneVerificationStatus": null, "HomePhoneVerificationDate": null, "RawMobilePhoneNumber": null, "MobilePhoneVerificationStatus": null, "MobilePhoneVerificationDate": null, "RawWorkPhoneNumber": null, "WorkPhoneVerificationStatus": null, "WorkPhoneVerificationDate": null, "EmailAddress": null, "EmailVerificationStatus": null, "EmailVerificationDate": null, "OrganizationPartyNumber": null, "OrganizationPartyName": null, "OrganizationSourceSystem": null, "OrganizationSourceSystemReferenceValue": null, "PersonDEO_OPACustomTestParent_OPACOContact_c": null, "PersonDEO_OPACustomTestParent_OPACOContact_Id_c": null, "PersonDEO_CustomText_c": null, "PersonDEO_CustomNumber_c": null, "PersonDEO_CustomDate_c": null, "PersonDEO_CustomDatetime_c": null, "PersonDEO_CustomFlag_c": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798", "name": "hubPersons", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000004770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000057371007E0002000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000778" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798", "name": "hubPersons", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/AdditionalIdentifier", "name": "AdditionalIdentifier", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/AdditionalName", "name": "AdditionalName", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/Address", "name": "Address", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/Attachment", "name": "Attachment", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/ContactPoint", "name": "ContactPoint", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/CustomerClassification", "name": "CustomerClassification", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/Note", "name": "Note", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/PersonDEO_ContactActualChildCollection_c", "name": "PersonDEO_ContactActualChildCollection_c", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/PersonDEO_OPACustomTestChild2_OPAContactChildCO_Tgt", "name": "PersonDEO_OPACustomTestChild2_OPAContactChildCO_Tgt", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/Relationship", "name": "Relationship", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/SourceSystemReference", "name": "SourceSystemReference", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubPersons/CDRM_7798/child/UsageAssignment", "name": "UsageAssignment", "kind": "collection" } ] }