1. REST API for Oracle Loyalty Cloud
  2. Tasks
  3. Partners

Get all partners

get

/crmRestApi/resources/11.13.18.05/partners

Request

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

    Format: ?fields=Attribute1,Attribute2

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

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

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

    • CompanyNumberRF: Finds the partner resource by partner number.
      Finder Variables:
      • CompanyNumber; string; The company number of the partner.
    • MyPartners: Finds the partner resource by record set.
      Finder Variables:
      • RecordSet; string; The value of the record set.
    • PrimaryKey: Finds the partner resource by primary key.
      Finder Variables:
      • OrganizationProfileId; integer; Finds a partner???s organization profile with ID.
      • PartyId; integer; Finds a partner???s party with ID.
    • SourceSystemReferenceAltKey: Finds a partner by source system reference value.
      Finder Variables:
      • SourceSystem; string; The name of the external source system for the partner.
      • SourceSystemReferenceValue; string; The identifier of the partner record from external source system.
    • SourceSystemReferenceRF: Finds a partner by source system and source system reference value.
      Finder Variables:
      • BindSourceSystem; string; The name of the external source system of the partner.
      • BindSourceSystemReferenceValue; string; The identifier of the partner record from external source system.
      • BindSysDate; string; This is an internal attribute and should not be used.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

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

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AccountDirectorId; integer; The unique identifier of the partner account owner.
    • AddrElementAttribute1; string; An additional address element to support flexible address format.
    • AddrElementAttribute2; string; An additional address element to support flexible address format.
    • AddrElementAttribute3; string; An additional address element to support flexible address format.
    • AddrElementAttribute4; string; An additional address element to support flexible address format.
    • AddrElementAttribute5; string; An additional address element to support flexible address format.
    • AddressLineFour; string; The fourth line for address of the partner.
    • AddressLineOne; string; The first line for address.
    • AddressLineThree; string; The third line for address.
    • AddressLineTwo; string; The second line for address.
    • AddressLinesPhonetic; string; The phonetic or kana representation of the Kanji address lines (used in Japan).
    • AnnualRevenue; number; The partner company's annual revenue.
    • Building; string; The building name or number in the address of the partner.
    • BusinessScope; string; The physical class of business in which a business participates, such as local, national, or international.
    • CeoName; string; The name of the chief executive officer of the partner.
    • City; string; The city of the identifying address.
    • CompanyNumber; string; The alternate key identifier of the partner's company.
    • ComplianceReviewedDate; string; The date when the compliance review that determines the partner's compliance status was last completed.
    • ComplianceStatus; string; The compliance status of the partner with the organization's criteria. If the value is Y, then the partner is a compliant. The default value is N.
    • ControlYr; number; The year when current ownership gained control.
    • Country; string; The country of the address. Review the list of countries using the Manage Geographies task.
    • CountryName; string; The name of the country associated with the partner company.
    • County; string; The county of the address.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date and time the record was created.
    • DUNSNumberC; string; The DUNS number, a unique, nine-digit identification number that is assigned to business entities by Dun & Bradstreet.
    • DbRating; string; The Dun & Bradstreet credit rating.
    • EligibleForPublicProfile; string; Indicates if the partner is eligible for publishing their public profile. If the value is True, then the partner is eligible.
    • EmailAddress; string; The e-mail address of the contact point.
    • EmailFormat; string; Indicates the preferred format for e-mail addressed to this address, such as HTML or ASCII.
    • EmployeesTotal; number; The total number of employees.
    • FaxNumber; string; The fax number of partner organization.
    • FloorNumber; string; The floor number of the address.
    • FormattedAddress; string; The formatted address of the partner.
    • HomeCountry; string; The home country of the partner.
    • IndstClassCategory; string; The classification category of the industry to which the partner belongs.
    • IndstClassCode; string; The classification code of the industry to which the partner belongs.
    • IndustryName; string; The classification name of the industry to which the partner belongs.
    • JgzzFiscalCode; string; The tax identification number of the partner.
    • LastUpdateDate; string; The date on which the record is last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • Latitude; number; The latitude information for the address of the partner. The latitude information for the location is used for spatial proximity and containment purposes.
    • LineOfBusiness; string; The type of business activities performed at this site.
    • Longitude; number; The longitude information for the address of the partner. The longitude information for the location is used for spatial proximity and containment purposes.
    • Mailstop; string; The user-defined code that indicates a mail drop point within the organization.
    • OpportunitiesWonPriorYear; number; The opportunities that the partner sales representatives closed and won in the prior fiscal year.
    • OpportunitiesWonYTD; number; The opportunities that the partner sales representatives closed and won in the current fiscal year-to-date.
    • OrganizationName; string; The name of the partner.
    • OrganizationProfileId; integer; The unique identifier for the partner profile.
    • OrganizationSize; string; The size of the organization based on its revenue, number of employees, and so on.
    • OwnerName; string; The name of the owner of the partner.
    • OwnerPartyNumber; string; The unique identifier of the owner of the partner company.
    • ParentPartnerId; string; The unique identifier of the parent partner.
    • ParentPartnerName; string; The name of the parent partner.
    • ParentPartnerOrigSystem; string; ParentPartnerOrigSystem and ParentPartnerOrigSystemReference uniquely identify a partner based on the reference ID for this partner in another external system. Setting these two values correctly sets the parent partner for the current partner.
    • ParentPartnerOrigSystemReference; string; ParentPartnerOrigSystem and ParentPartnerOrigSystemReference uniquely identify a partner based on the reference ID for this partner in another external system. Setting these two values correctly sets the parent partner for the current partner.
    • ParentPartnerPartyId; integer; The unique identifier of the parent partner party.
    • ParentPartnerPartyNumber; string; The alternate key identifier of the parent partner party.
    • PartnerLevel; string; The relative tier of the partner.
    • PartnerSummary; string; A brief description of the partner company.
    • PartyId; integer; The unique identifier of the partner.
    • PartyNumber; string; The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
    • PhoneAreaCode; string; The area code of the telephone number.
    • PhoneCountryCode; string; The international country code for a telephone number, such as 33 for France.
    • PhoneExtension; string; The additional number used after initial connection to an internal telephone system.
    • PhoneLineType; string; The lookup code for the type of phone line, such as general, fax, inbound, or outbound.
    • PhoneNumber; string; A telephone number formatted in the local format. The number should not include area code, country code, or extension.
    • PostalCode; string; The postal code of the address.
    • PostalPlus4Code; string; The four-digit extension to the United States Postal ZIP code for the address.
    • PreferredContactPersonId; integer; The unique identifier of the preferred contact person for this partner.
    • PreferredFunctionalCurrency; string; The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup.
    • PrimaryContactEmailAddress; string; The e-mail address of the partners' primary contact.
    • PrimaryContactPartyName; string; The name of the partners's primary contact.
    • PrimaryContactPartyNumber; string; The party number of the primary contact of the partner.
    • PrincipalName; string; The name of the highest ranking person in the organization.
    • Province; string; The province of the address.
    • PublicAddressId; integer; The unique identifier of the public address.
    • PublicAddressNumber; string; The unique identifier of the public address.
    • PublicContactId; integer; The unique identifier of the public contact of the partner company.
    • PublicContactName; string; The name of the public contact of the partner company.
    • PublicContactPartyNumber; string; The party number of the public contact of the partner company.
    • PublicEmailAddress; string; The public e-mail address of the partner company.
    • PublicEmailId; integer; The unique identifier of the public email id.
    • PublicFaxId; integer; The unique identifier of the public fax number for the partner company.
    • PublicPhoneId; integer; The unique identifier of the public phone number.
    • PublicStatus; string; The status of approval of public profile.
    • RawPhoneNumber; string; The raw phone number.
    • SolutionOverview; string; The overview description of partner solutions.
    • State; string; The state element of the address.
    • Status; string; The status of the partner's relationship with the organization. This value is maintained by the channel manager.
    • StockSymbol; string; The corporate stock symbol of the organization as listed in stock exchanges.
    • Synergy; string; The description of the value of the partnership between the organization and partner.
    • TierId; integer; The unique identifier of the tier that the partner belongs to.
    • TierName; string; The name of the tier that the partner belongs to.
    • TierRanking; integer; The tier ranking of the partner company.
    • URL; string; The URL for the partner's web presence.
    • UpdateFlag; boolean; Indicates whether the partner object can be updated by the current user or not. If the value is True, then the partner object can be updated.
    • WebType; string; The prefix class to a web address, such as FTP or HTTP.
    • YearEstablished; integer; The year that the organization started its business operations.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : partners
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : partners-item-response
Type: object
Show Source
  • The unique identifier of the partner account owner.
  • Partner Account Team Members
    Title: Partner Account Team Members
    The partner account team members resource is used to view, create, update, and delete the team members who will work with the partner. The team members are responsible for a partner account, and have access to edit the partner account information.
  • Title: Additional Address Element 1
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Addresses
    Title: Addresses
    The addresses resource is used to view, create, update, and delete addresses of a partner.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address of the partner.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or kana representation of the Kanji address lines (used in Japan).
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Annual Revenue
    The partner company's annual revenue.
  • Assessments
    Title: Assessments
    The assessments resource is used to view, create, update, and delete the assessment of a partner.
  • Attachments
    Title: Attachments
    An attachments resource is used to view, create, modify or delete the partner's attachments.
  • Title: Building
    Maximum Length: 240
    The building name or number in the address of the partner.
  • Title: Business Scope
    Maximum Length: 20
    The physical class of business in which a business participates, such as local, national, or international.
  • Title: Chief Executive Name
    Maximum Length: 240
    The name of the chief executive officer of the partner.
  • Partner Certifications
    Title: Partner Certifications
    The partner certifications resource is used to view, create, and delete the certifications of a partner. Through certifications, partners can qualify for competencies offered by the channel organization and become eligible for higher partner levels (Gold, Silver, Bronze), increased discounts, and so on.
  • Title: City
    Maximum Length: 60
    The city of the identifying address.
  • Title: Partner Number
    Maximum Length: 30
    The alternate key identifier of the partner's company.
  • Title: Compliance Reviewed Date
    The date when the compliance review that determines the partner's compliance status was last completed.
  • Title: Compliance Status
    Maximum Length: 50
    The compliance status of the partner with the organization's criteria. If the value is Y, then the partner is a compliant. The default value is N.
  • Contact Points
    Title: Contact Points
    The contact points resource is used to view, create, update, and delete the partner's contact points such as e-mail address, phone number, fax number etc. These contact points can be assiged as a public contact point for the partner. For example, a contact point created for an e-mail address can be assigned as a public e-mail address for the partner.
  • Partner Contacts
    Title: Partner Contacts
    The partner contacts resource is used to view, create, update, and delete the contacts of a partner company. For example, a partner sales rep, a partner sales manager, a partner administrator, and so on. Note: The following attributes are not supported in the Partner Contacts resource, though they are listed for the Partner object in the App Composer: ContactRole, ContactStatus, RegistrationStatus, SalesProfileStatus, RecordSet, DataCloudStatus, and TimezoneCode.
  • Title: Organization Control Year
    The year when current ownership gained control.
  • Maximum Length: 15
    The corporate currency code of the Partner. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Country
    Maximum Length: 2
    The country of the address. Review the list of countries using the Manage Geographies task.
  • Title: Country
    Read Only: true
    The name of the country associated with the partner company.
  • Title: County
    Maximum Length: 60
    The county of the address.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date and time the record was created.
  • Maximum Length: 15
    The currency code associated with the Partner. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: D&B Credit Rating
    Maximum Length: 5
    The Dun & Bradstreet credit rating.
  • Title: D-U-N-S Number
    Maximum Length: 30
    The DUNS number, a unique, nine-digit identification number that is assigned to business entities by Dun & Bradstreet.
  • Title: Eligible for Public Profile
    Maximum Length: 1
    Indicates if the partner is eligible for publishing their public profile. If the value is True, then the partner is eligible.
  • Title: Email
    Maximum Length: 320
    The e-mail address of the contact point.
  • Title: Email Format
    Maximum Length: 30
    Indicates the preferred format for e-mail addressed to this address, such as HTML or ASCII.
  • Title: Number of Employees
    The total number of employees.
  • Expertises
    Title: Expertises
    The expertise resource is used to view, create, and delete the partner's expertise. Partner expertise indicates areas where the partner has special knowledge or skill.
  • Title: Phone
    Maximum Length: 40
    The fax number of partner organization.
  • Title: Floor
    Maximum Length: 40
    The floor number of the address.
  • Title: Address
    Read Only: true
    The formatted address of the partner.
  • Title: Phone Number
    Read Only: true
    The formatted phone number of the organization.
  • Geographies
    Title: Geographies
    The partner geographies resource is used to view, create, delete the geographies that the partner operates in, such as US, CA, and so on.
  • Title: Home Country
    Maximum Length: 2
    The home country of the partner.
  • Title: Classification Category
    Maximum Length: 255
    The classification category of the industry to which the partner belongs.
  • Title: Classification Code
    The classification code of the industry to which the partner belongs.
  • Industries
    Title: Industries
    The industries resource is used to view, create, and delete the industries that a channel partner works with. For example, a partner's industry can be manufacturing or automotive.
  • Title: Classification Code Meaning
    Read Only: true
    Maximum Length: 80
    The classification name of the industry to which the partner belongs.
  • Default Value: false
    Indicates whether an existing account would be converted to partner. If the value is 'Y', then the party id of the existing account would be used for the partner.
  • Maximum Length: 80
    Indicates whether this partner is self-registered or not. If the value is Y, then the partner is self-registered. If you submit a Partner POST or PATCH call with this flag set to Y, then the partner approval process is initiated. If you submit a POST or PATCH call with this flag set to N, or this flag is omitted, then the partner approval process is not initiated.
  • Title: Taxpayer Identification Number
    Maximum Length: 20
    The tax identification number of the partner.
  • Read Only: true
    The date on which the record is last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record.
  • Title: Latitude
    The latitude information for the address of the partner. The latitude information for the location is used for spatial proximity and containment purposes.
  • Title: Line of Business
    Maximum Length: 240
    The type of business activities performed at this site.
  • Links
  • Title: Longitude
    The longitude information for the address of the partner. The longitude information for the location is used for spatial proximity and containment purposes.
  • Title: Mail Stop
    Read Only: true
    Maximum Length: 60
    The user-defined code that indicates a mail drop point within the organization.
  • Notes
    Title: Notes
    The note resource is used to view, create, update, and delete notes associated with a partner. A note captures comments, information, or instructions related to a partner.
  • Title: Opportunities Won Prior Year
    The opportunities that the partner sales representatives closed and won in the prior fiscal year.
  • Title: Opportunities Won Year to Date
    The opportunities that the partner sales representatives closed and won in the current fiscal year-to-date.
  • Title: Organization Name
    Maximum Length: 360
    The name of the partner.
  • Read Only: true
    The unique identifier for the partner profile.
  • Title: Organization Size
    Maximum Length: 30
    The size of the organization based on its revenue, number of employees, and so on.
  • Title: Owner
    Read Only: true
    Maximum Length: 450
    The name of the owner of the partner.
  • Read Only: true
    Maximum Length: 30
    The unique identifier of the owner of the partner company.
  • Title: Parent Primary Key 1 Value
    Read Only: true
    Maximum Length: 100
    The unique identifier of the parent partner.
  • Title: Parent Partner List
    Read Only: true
    Maximum Length: 255
    List of all the parent partners till the top node in the partner hierarchy.
  • Title: Parent Partner
    Read Only: true
    The name of the parent partner.
  • Title: Parent Partner Original System
    Read Only: true
    Maximum Length: 30
    ParentPartnerOrigSystem and ParentPartnerOrigSystemReference uniquely identify a partner based on the reference ID for this partner in another external system. Setting these two values correctly sets the parent partner for the current partner.
  • Title: Parent Partner Original System Reference
    Read Only: true
    Maximum Length: 255
    ParentPartnerOrigSystem and ParentPartnerOrigSystemReference uniquely identify a partner based on the reference ID for this partner in another external system. Setting these two values correctly sets the parent partner for the current partner.
  • Title: Parent Partner Party ID
    The unique identifier of the parent partner party.
  • Title: Parent Partner Company Number
    Maximum Length: 30
    The alternate key identifier of the parent partner party.
  • Partner Announcements
    Title: Partner Announcements
    The partner annoucements resource is used to view the partner annoucements which are relavant to the partner user based on the partner company. The partner annoucements are created by channel users and the audience is defined based on partner company or attributes of the partner company.
  • Title: Partner Level
    Maximum Length: 50
    The relative tier of the partner.
  • Partner Rollups
    Title: Partner Rollups
    The partner rollups resource is used to view all the rollup attributes and their values defined for a partner.
  • Title: Partner Summary
    Maximum Length: 4000
    A brief description of the partner company.
  • Partner Teams
    Title: Partner Teams
    The partner teams resource is used to view the team members and territory team members associated with an partner.
  • The unique identifier of the partner.
  • Title: Registry ID
    Maximum Length: 30
    The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
  • Title: Area Code
    Maximum Length: 20
    The area code of the telephone number.
  • Title: Phone Country Code
    Maximum Length: 10
    The international country code for a telephone number, such as 33 for France.
  • Title: Extension
    Maximum Length: 20
    The additional number used after initial connection to an internal telephone system.
  • Title: Type
    Maximum Length: 30
    Default Value: GEN
    The lookup code for the type of phone line, such as general, fax, inbound, or outbound.
  • Title: Phone
    Maximum Length: 40
    A telephone number formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code for the address.
  • Title: Primary Contact Party ID
    The unique identifier of the preferred contact person for this partner.
  • Title: Preferred Functional Currency
    Maximum Length: 15
    The code indicating the organization's default currency. A list of valid currency codes are defined during the application setup.
  • Title: Contact Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the partners' primary contact.
  • Title: Primary Contact
    Read Only: true
    Maximum Length: 360
    The name of the partners's primary contact.
  • Title: Primary Contact Registry ID
    Read Only: true
    Maximum Length: 30
    The party number of the primary contact of the partner.
  • Title: Primary Phone
    Read Only: true
    The phone number of the partner's primary contact.
  • Title: Principal Name
    Maximum Length: 240
    The name of the highest ranking person in the organization.
  • Focus Areas
    Title: Focus Areas
    The focus areas resource is used to view, create, or delete the partner's focus areas. For example, a partner's focus area can be green servers.
  • Title: Province
    Maximum Length: 60
    The province of the address.
  • Title: Public Address
    Read Only: true
    The public address of the partner company.
  • The unique identifier of the public address.
  • Title: Site Number
    Read Only: true
    Maximum Length: 30
    The unique identifier of the public address.
  • The unique identifier of the public contact of the partner company.
  • Title: Public Contact
    Read Only: true
    Maximum Length: 360
    The name of the public contact of the partner company.
  • Read Only: true
    Maximum Length: 30
    The party number of the public contact of the partner company.
  • Title: Public Email
    Read Only: true
    Maximum Length: 320
    The public e-mail address of the partner company.
  • The unique identifier of the public email id.
  • The unique identifier of the public fax number for the partner company.
  • Title: Public Fax
    Read Only: true
    The public fax number of the partner company.
  • The unique identifier of the public phone number.
  • Title: Public Phone
    Read Only: true
    The public phone number of the partner company.
  • Title: Public Status
    Maximum Length: 50
    The status of approval of public profile.
  • Title: Phone
    Maximum Length: 60
    The raw phone number.
  • Record Set Lookup
    Title: Record Set Lookup
    The recordset lookup resource lets you create, update and delete a recortset lookup.
  • Title: Run Data Sync
    This attribute triggers the activation flow for any active or non active partner to process and synchronize the data. This attribute should never be used.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Solution Overview
    Maximum Length: 4000
    The overview description of partner solutions.
  • The name of the external source system.
  • The identifier of the record from external source system.
  • Read Only: true
    The type of the source object such as Opportunities or Partners as defined in the object metadata.
  • Read Only: true
    Maximum Length: 30
    Default Value: HZ_PARTIES
    This is an internal system attribute and should never be used.
  • Title: State
    Maximum Length: 60
    The state element of the address.
  • Title: Status
    Maximum Length: 50
    The status of the partner's relationship with the organization. This value is maintained by the channel manager.
  • Title: Stock Symbol
    Maximum Length: 20
    The corporate stock symbol of the organization as listed in stock exchanges.
  • Maximum Length: 4000
    The description of the value of the partnership between the organization and partner.
  • Title: Tier
    The unique identifier of the tier that the partner belongs to.
  • Title: Tier
    Read Only: true
    Maximum Length: 155
    The name of the tier that the partner belongs to.
  • Title: Tier
    Read Only: true
    The tier ranking of the partner company.
  • Title: Total Child Partners
    Read Only: true
    The total number of direct and indirect child partners in the hierarchy.
  • Title: Total Immediate Child Partners
    Read Only: true
    The number of immediate child nodes in hierarchy for the partner.
  • Title: Total Partners in Hierarchy
    Read Only: true
    The total number of partners in the hierarchy.
  • Partner Types
    Title: Partner Types
    The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, a distributor, a manufacturer, and so on.
  • Read Only: true
    Indicates whether the partner object can be updated by the current user or not. If the value is True, then the partner object can be updated.
  • Title: URL
    Maximum Length: 2000
    The URL for the partner's web presence.
  • Title: Protocol
    Maximum Length: 60
    Default Value: HTTP
    The prefix class to a web address, such as FTP or HTTP.
  • Title: Year Established
    The year that the organization started its business operations.
Nested Schema : Partner Account Team Members
Type: array
Title: Partner Account Team Members
The partner account team members resource is used to view, create, update, and delete the team members who will work with the partner. The team members are responsible for a partner account, and have access to edit the partner account information.
Show Source
Nested Schema : Addresses
Type: array
Title: Addresses
The addresses resource is used to view, create, update, and delete addresses of a partner.
Show Source
Nested Schema : Assessments
Type: array
Title: Assessments
The assessments resource is used to view, create, update, and delete the assessment of a partner.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments.
Show Source
Nested Schema : Partner Certifications
Type: array
Title: Partner Certifications
The partner certifications resource is used to view, create, and delete the certifications of a partner. Through certifications, partners can qualify for competencies offered by the channel organization and become eligible for higher partner levels (Gold, Silver, Bronze), increased discounts, and so on.
Show Source
Nested Schema : Contact Points
Type: array
Title: Contact Points
The contact points resource is used to view, create, update, and delete the partner's contact points such as e-mail address, phone number, fax number etc. These contact points can be assiged as a public contact point for the partner. For example, a contact point created for an e-mail address can be assigned as a public e-mail address for the partner.
Show Source
Nested Schema : Partner Contacts
Type: array
Title: Partner Contacts
The partner contacts resource is used to view, create, update, and delete the contacts of a partner company. For example, a partner sales rep, a partner sales manager, a partner administrator, and so on. Note: The following attributes are not supported in the Partner Contacts resource, though they are listed for the Partner object in the App Composer: ContactRole, ContactStatus, RegistrationStatus, SalesProfileStatus, RecordSet, DataCloudStatus, and TimezoneCode.
Show Source
Nested Schema : Expertises
Type: array
Title: Expertises
The expertise resource is used to view, create, and delete the partner's expertise. Partner expertise indicates areas where the partner has special knowledge or skill.
Show Source
Nested Schema : Geographies
Type: array
Title: Geographies
The partner geographies resource is used to view, create, delete the geographies that the partner operates in, such as US, CA, and so on.
Show Source
Nested Schema : Industries
Type: array
Title: Industries
The industries resource is used to view, create, and delete the industries that a channel partner works with. For example, a partner's industry can be manufacturing or automotive.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note resource is used to view, create, update, and delete notes associated with a partner. A note captures comments, information, or instructions related to a partner.
Show Source
Nested Schema : Partner Announcements
Type: array
Title: Partner Announcements
The partner annoucements resource is used to view the partner annoucements which are relavant to the partner user based on the partner company. The partner annoucements are created by channel users and the audience is defined based on partner company or attributes of the partner company.
Show Source
Nested Schema : Partner Rollups
Type: array
Title: Partner Rollups
The partner rollups resource is used to view all the rollup attributes and their values defined for a partner.
Show Source
Nested Schema : Partner Teams
Type: array
Title: Partner Teams
The partner teams resource is used to view the team members and territory team members associated with an partner.
Show Source
Nested Schema : Focus Areas
Type: array
Title: Focus Areas
The focus areas resource is used to view, create, or delete the partner's focus areas. For example, a partner's focus area can be green servers.
Show Source
Nested Schema : Record Set Lookup
Type: array
Title: Record Set Lookup
The recordset lookup resource lets you create, update and delete a recortset lookup.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Partner Types
Type: array
Title: Partner Types
The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, a distributor, a manufacturer, and so on.
Show Source
Nested Schema : partners-accountTeamMembers-item-response
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    Default Value: 300
    The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Assignment Type
    Maximum Length: 30
    Default Value: MANUAL
    The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time the record was created.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the resource.
  • Title: Primary Address
    Read Only: true
    The formatted version of the address.
  • Title: Phone
    Read Only: true
    The phone number of the resource.
  • Title: Last Updated Date
    Read Only: true
    The date on which the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record.
  • Links
  • Title: Function
    Maximum Length: 30
    The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Title
    The role of the resource in the organization.
  • Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.
  • Title: Partner Account Resource ID
    The unique identifier of the party that owns the partner.
  • Title: Partner Number
    Maximum Length: 30
    The unique identifier of the partner company.
  • Title: Account Team Member
    The unique identifier of the sale profile of the resource.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the resource.
  • Title: Registry ID
    Read Only: true
    Maximum Length: 30
    The party number for the resource of the partner account team.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-accountTeamMembers-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-accountTeamMembers-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partners-accountTeamMembers-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partners-accountTeamMembers-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : partners-addresses-item-response
Type: object
Show Source
  • Title: Additional Address Element 1
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Read Only: true
    The unique identifier of the address.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Lines Phonetic
    Maximum Length: 560
    The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Site Number
    Maximum Length: 30
    The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update.
  • Title: Type
    The lookup code for the type of address, such as billing address, shipping address etc.
  • Title: Building
    Maximum Length: 240
    The building name or number in the address.
  • Title: City
    Maximum Length: 60
    The city in the address.
  • Title: CLLI Code
    Maximum Length: 60
    The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address.
  • Title: Comments
    Maximum Length: 2000
    The user-provided comments for the address.
  • Maximum Length: 15
    The corporate currency code of the address associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Country
    Maximum Length: 2
    The country of the address. Review the list of countries using the Manage Geographies task.
  • Read Only: true
    The name of the country of the partner company.
  • Title: County
    Maximum Length: 60
    The county of the address.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the address record.
  • Title: Created by Application
    Maximum Length: 30
    The module that created the address record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • 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.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the address. 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.
  • Title: Validated Date
    The date when the address was last validated.
  • Title: Description
    Maximum Length: 2000
    The description of the location.
  • Title: Contact Preferences
    Default Value: false
    Indicates whether the address should not be used for mailing.
  • Title: Floor
    Maximum Length: 40
    The floor number of the address.
  • Title: Address
    Read Only: true
    The formatted version of the address.
  • Title: Address
    Read Only: true
    The formatted multiline version of the address.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Title: Latitude
    The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
  • Links
  • Title: Location Directions
    Maximum Length: 640
    The directions to the address location.
  • Title: Location ID
    The unique identifier for the location.
  • Title: Longitude
    The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
  • Title: Mail Stop
    Maximum Length: 60
    The user-defined code that indicates a mail drop point within the organization.
  • Title: Party ID
    The unique identifier of the partner associated with the address.
  • Title: Postal Code
    Maximum Length: 60
    The postal code of the address.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code for the address.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N.
  • Title: Province
    Maximum Length: 60
    The province of the address.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • The identifier of the record from external source system.
  • The name of the external source system.
  • Title: State
    Maximum Length: 60
    The state of the address.
  • Title: Validated
    Maximum Length: 1
    Default Value: false
    Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-addresses-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-addresses-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partners-addresses-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partners-addresses-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : partners-Assessment-item-response
Type: object
Show Source
Nested Schema : Assessment Answer Groups
Type: array
Title: Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment.
Show Source
Nested Schema : partners-Assessment-AssessAnswerGroups-item-response
Type: object
Show Source
Nested Schema : Assessment Answers
Type: array
Title: Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group.
Show Source
Nested Schema : partners-Assessment-AssessAnswerGroups-AssessmentAnswer-item-response
Type: object
Show Source
Nested Schema : partners-attachments-item-response
Type: object
Show Source
Nested Schema : partners-certifications-item-response
Type: object
Show Source
Nested Schema : partners-contactPoints-item-response
Type: object
Show Source
  • Title: Conflict ID
    Default Value: 0
    The unique identifier of the conflict. Note: This is an internal attribute and should not be used.
  • Title: Contact Point ID
    Read Only: true
    The unique identifier of the contact point.
  • Title: Type
    Maximum Length: 30
    The type of the contact point such as EMAIL or PHONE.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the contact point record.
  • Title: Created by Application
    Default Value: HZ_WS
    The module that created the contact point record.
  • Title: Creation Date
    Read Only: true
    The date when the contact point record was created.
  • Title: OK to Contact
    Indicates whether to use a particular contact method. Defaulted to false.
  • Title: Do Not Contact
    Indicates whether the contact point is not preferred for contact.
  • Title: Do Not Contact Reason
    Indicates the reason for "Do Not Contact" preference.
  • Title: Email
    Maximum Length: 255
    The e-mail address in the contact point.
  • Title: Email Purpose
    Maximum Length: 30
    The e-mail purpose for the email address in the contact point. For example: "BUSINESS" determines the purpose of the e-mail address.
  • Title: Phone Number
    Read Only: true
    Maximum Length: 255
    The formatted phone number in the contact point.
  • Title: Last Update Date
    Read Only: true
    The date when the contact point record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the contact point record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the contact point record.
  • Links
  • Title: Object Version Number
    The object version number. (This is an internal attribute and should not be used)
  • Title: Party ID
    The unique identifier of the party of the partner company.
  • Title: Registry ID
    The party number of the partner company.
  • Title: Party Source System
    The name of the external source system.
  • Title: Party Source System Reference Value
    The identifier of the record from external source system.
  • Title: Area Code
    Maximum Length: 255
    The area code of the phone number in the contact point.
  • Title: Phone Country Code
    Maximum Length: 255
    The phone country code of the phone number in the contact point.
  • Title: Extension
    Maximum Length: 255
    The phone extension of the phone number in the contact point.
  • Title: Phone
    Maximum Length: 255
    The phone number in the contact point.
  • Title: Phone Purpose
    Maximum Length: 30
    The purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
  • Title: Type
    The type of the phone number in the contact point. For example: "FAX" or "WORK" determines the type of the phone number.
  • Title: Preference Requested By
    The list of values indicating the preference requested.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether the contact point is primary.
  • Title: Phone
    Maximum Length: 255
    The raw phone number in the contact point.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: User ID
    The social network identifier. Note: This is an internal attribute and should not be used.
  • Title: Social Network
    The social network name. Note: This is an internal attribute and should not be used.
  • 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.
  • Title: Source System
    The name of the external source system.
  • Title: Source System Reference Value
    The identifier of the record from external source system.
  • Title: Status
    Maximum Length: 30
    Default Value: A
    The status of the contact point.
  • Title: URL
    The URL in the contact point.
  • Title: Verification Date
    The date of verification of the phone or email contact point.
  • Title: Verification Status
    Maximum Length: 30
    The list of values indicating the purpose of the social network.
  • Title: Web Purpose
    Maximum Length: 30
    The purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-contactPoints-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-contactPoints-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partners-contactPoints-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partners-contactPoints-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : partners-contacts-item-response
Type: object
Show Source
  • Title: Academic Title
    Maximum Length: 30
    The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith.
  • Title: Additional Address Element 1
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 2
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 3
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 4
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Additional Address Element 5
    Maximum Length: 150
    An additional address element to support flexible address format.
  • Title: Address Line 4
    Maximum Length: 240
    The fourth line for address of the contact.
  • Title: Address Line 1
    Maximum Length: 240
    The first line for address.
  • Title: Address Line 3
    Maximum Length: 240
    The third line for address.
  • Title: Address Line 2
    Maximum Length: 240
    The second line for address.
  • Title: Address Type
    The lookup code for the type of address, such as billing address, shipping address etc.
  • Attachments
    Title: Attachments
    An attachments resource is used to view, create, modify or delete the partner's attachments.
  • Title: Building
    Maximum Length: 240
    The building name or number in the address of the contact.
  • Title: Certification Level
    Maximum Length: 30
    The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Certification Reason
    Maximum Length: 30
    The code indicating the reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: City
    Maximum Length: 60
    The city element of the address.
  • Title: Comments
    Maximum Length: 2000
    The textual comments about a contact.
  • Title: Name
    Maximum Length: 450
    The derived name of the contact.
  • Title: Country
    Maximum Length: 2
    The country code of the address. Review the list of country codes using the Manage Geographies task.
  • Read Only: true
    The name for the country of the partner company.
  • Title: County
    Maximum Length: 60
    The county of the address.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Indicates whether the user account should be created. This should not be used currently.
  • Read Only: true
    The date and time the record was created.
  • Title: Date of Birth
    The date when the person was born.
  • Title: Date of Death
    The date when the person died.
  • 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.
  • Title: Declared Ethnicity
    Maximum Length: 60
    The declared ethnicity of the person.
  • Title: Department
    Maximum Length: 60
    The free form text used to name the department for the contact.
  • 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.
  • Title: Do Not Call
    Maximum Length: 1
    Indicates if 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.
  • Title: Do Not Contact
    Maximum Length: 1
    Indicates if the user can contact the person by phone, Email, or snail 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.
  • Title: Do Not Email
    Maximum Length: 1
    Indicates if the user can email the person or not. If the value is True, then the user must not contact the person by email. 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.
  • Title: Do Not Mail
    Maximum Length: 1
    Indicates if 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.
  • Title: Email
    Maximum Length: 320
    The e-mail address of the partner contact.
  • Title: Favorite
    Maximum Length: 10
    Default Value: false
    Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.
  • Title: First Name
    Maximum Length: 150
    The first name of the person.
  • Title: Floor
    Maximum Length: 40
    The floor number of the address.
  • Title: Primary Address
    Read Only: true
    The formatted address of the partner contact.
  • Title: Phone Number
    Read Only: true
    The formatted mobile phone number information.
  • Title: Phone Number
    Read Only: true
    The formatted work phone number information.
  • 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.
  • Title: Head of Hierarchy
    Maximum Length: 255
    Indicates whether this partner contact is a root resource of Partner or not. The value 'Y' indicates that this partner contact is a root resource of the partner.
  • Title: Initials
    Maximum Length: 20
    The initials of the contact???s name.
  • Default Value: false
    Indicates whether an existing contact from an account would be converted to partner contact. The value 'Y' indicates that the party id of the existing account contact would be used for the partner contact if the related account is already a partner.
  • Title: Self-Registered
    Indicates whether the partner registration approval process will be invoked or not. If the value is Y, then the process will be invoked.
  • Title: Job Title
    Maximum Length: 100
    The job title of the primary contact.
  • Title: Job Title Code
    Maximum Length: 30
    The code indicating the job title.
  • Title: Last Name
    Maximum Length: 150
    The last name of the person.
  • Title: Last Name Prefix
    Maximum Length: 30
    The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute.
  • Read Only: true
    The date on which the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record.
  • Title: Latitude
    The latitude information for the address of the contact. The latitude information for the location is used for spatial proximity and containment purposes.
  • Links
  • Title: Longitude
    The longitude information for the address of the contact. The longitude information for the location is used for spatial proximity and containment purposes.
  • Title: Mail Stop
    Maximum Length: 60
    The user-defined code that indicates a mail drop point within the organization.
  • Title: Manager
    Read Only: true
    Maximum Length: 255
    The name of the manager of partner contact.
  • Title: Manager
    The unique identifier of the manager party of the partner contact.
  • Maximum Length: 30
    The party number of the manager of the partner contact.
  • 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.
  • Title: Marital Status Effective Date
    The date when the person's marital status was changed.
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person.
  • Title: Area Code
    Maximum Length: 20
    The area code for partner contact's mobile phone.
  • Title: Phone Country Code
    Maximum Length: 10
    The international country code for a partner contact???s mobile phone number, such as 33 for France.
  • Title: Extension
    Maximum Length: 20
    The additional number used after initial connection to an internal telephone system.
  • Title: Phone
    Maximum Length: 40
    The mobile phone number of partner contact formatted in the local format. The number should not include area code, country code, or extension.
  • Title: Named Contact
    Maximum Length: 1
    Default Value: false
    Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False.
  • Title: Suffix
    Maximum Length: 30
    The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix.
  • Title: Partner Number
    Maximum Length: 30
    The unique identifier of the partner company.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the partner associated with the contact.
  • The unique identifier of the party associated with the partner.
  • The unique identifier of the partner contact party generated by the system during creation.
  • Title: Registry ID
    Maximum Length: 30
    The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.
  • Title: Prefix
    Maximum Length: 30
    The title or the salutary introduction for a contact, such as Mr., Herr, and so on.
  • Title: Place of Birth
    Maximum Length: 60
    The place where the person was born, such as city or country.
  • Title: Postal Code
    Maximum Length: 60
    The postal code as defined by the formal countrywide postal system.
  • Title: Postal Code Extension
    Maximum Length: 20
    The four-digit extension to the United States Postal ZIP code for the address.
  • Title: Preferred Contact Method
    Maximum Length: 30
    The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
  • Title: Preferred Functional Currency
    Maximum Length: 15
    The preferred currency of the contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task.
  • Title: Previous Last Name
    Maximum Length: 150
    The previous last name or surname of the person.
  • The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
  • Read Only: true
    The party identifier of the primary contact of the partner.
  • Title: Primary Contact Indicator
    Maximum Length: 255
    Indicates whether this partner contact is primary contact of partner or not. If the value is True, then this partner contact is a primary contact.
  • Title: Province
    Maximum Length: 60
    The province of the address.
  • Title: Phone
    Maximum Length: 60
    The raw mobile phone number in the contact point.
  • Title: Phone
    Maximum Length: 60
    The raw work phone number in the contact point.
  • 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 is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Maximum Length: 30
    The role code of the partner contact.
  • Title: Role
    The unique identifier of the resource role of the partner contact.
  • Title: Role
    Read Only: true
    Maximum Length: 255
    The name of the resource role for partner contact.
  • 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.
  • Title: Buying Role
    Maximum Length: 30
    The code indicating the role 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.
  • Title: Salutation
    Maximum Length: 60
    The phrase used to address a contact party in any correspondence.
  • 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.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • The name of the external source system.
  • The identifier of the record from external source system.
  • Title: State
    Maximum Length: 60
    The state element of the address.
  • Title: Title
    Maximum Length: 60
    A professional or family title, such as Don or The Right Honorable.
  • Title: Type
    Maximum Length: 30
    The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Read Only: true
    Indicates whether the partner contact object can be updated by the current user or not. If the value is True, then the partner contact object can be updated.
  • Title: User Account Request Status
    Read Only: true
    Status and error description, if any, for create user account LDAP request.
  • User Account Details
    Title: User Account Details
    The user account details resource is used to view, create, update, and delete the user account details of a partner contact.
  • The user name of the account for the partner contact. This should not be used currently.
  • Title: Area Code
    Maximum Length: 20
    The area code for the partner contact's work phone.
  • Title: Phone Country Code
    Maximum Length: 10
    The international country code for a partner contact???s work phone number, such as 33 for France.
  • Title: Extension
    Maximum Length: 20
    The additional number used after initial connection to an internal telephone system.
  • Title: Phone
    Maximum Length: 40
    The work phone number of a partner contact formatted in the local format without the area code, country code, or extension.
Nested Schema : Attachments
Type: array
Title: Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : User Account Details
Type: array
Title: User Account Details
The user account details resource is used to view, create, update, and delete the user account details of a partner contact.
Show Source
Nested Schema : partners-contacts-attachments-item-response
Type: object
Show Source
Nested Schema : partners-contacts-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-contacts-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partners-contacts-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partners-contacts-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : partners-contacts-userdetails-item-response
Type: object
Show Source
Nested Schema : partners-expertises-item-response
Type: object
Show Source
Nested Schema : partners-geographies-item-response
Type: object
Show Source
Nested Schema : partners-industries-item-response
Type: object
Show Source
Nested Schema : partners-notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The relationship ID populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the note record.
  • Title: Creation Date
    Read Only: true
    The date and time when the note record was created.
  • Title: Creator Party ID
    The unique party identifier for the note creator.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
  • Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Read Only: true
    The address of the user who created the note.
  • Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    The date when the note data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique identifier of the note.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The actual note text.
  • Title: Type
    Maximum Length: 30
    The code indicating the type of the note.
  • Title: Parent Note ID
    The unique identifier of the partner note.
  • Read Only: true
    The unique identifier of the contact to which the note is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of this party.
  • Smart Actions
    Title: Smart Actions
    The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Related Object Type
    Maximum Length: 30
    The code indicating the type of the source object, such as Activities, Opportunities, and so on, as defined in OBJECTS Metadata.
  • Title: Related Object
    Maximum Length: 64
    The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-notes-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-notes-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partners-notes-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partners-notes-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : partners-partnerAnnouncements-item-response
Type: object
Show Source
Nested Schema : partners-partnerRollup-item-response
Type: object
Show Source
  • Title: Corporate Currency
    Read Only: true
    Maximum Length: 15
    The currency code associated with the Partner. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the row.
  • Title: Creation Date
    Read Only: true
    The date and time when the row was created.
  • Title: Converted Deals
    Read Only: true
    The count of the deal registrations converted to opportunities in current fiscal year.
  • Title: Hierarchy Approved MDF Claims
    Read Only: true
    Count of the MDF Claims that are approved of a Partner and it's hierarchies.
  • Title: Hierarchy Open MDF Claims
    Read Only: true
    Count of the open MDF Claims pending for approval of a Partner and it's hierarchies.
  • Title: Hierarchy Open MDF Requests
    Read Only: true
    Count of the open MDF Requests of a Partner and it's hierarchies .
  • Title: Hierarchy Open Opportunities
    Read Only: true
    Count of open Opportunities of a partner and its hierarchies.
  • Title: Hierarchy Enrollments Pending Approval
    Read Only: true
    Count of Enrollments that are pending for approval of a Partner and it's hierarchies.
  • Title: Hierarchy Open Opportunity Revenue
    Read Only: true
    Sum of the potential revenue from open opportunities of a partner and it's hierarchies.
  • Title: Hierarchy Approved MDF Claims Amount
    Read Only: true
    Sum of the MDF Claims amount that are approved of a Partner and it's hierarchies .
  • Title: Hierarchy Open MDF Claims Amount
    Read Only: true
    Sum of the open MDF Claims amount pending for approval of a Partner and it's hierarchies.
  • Title: Hierarchy Open MDF Requests Amount
    Read Only: true
    Sum of the open MDF Requests amount of a Partner and it's hierarchies.
  • Title: Hierarchy Total Open Opportunities Revenue for Next Quarter
    Read Only: true
    Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the next quarter.
  • Title: Hierarchy Total Open Opportunities Revenue in Current Quarter
    Read Only: true
    Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the current quarter.
  • Title: Hierarchy Total Won Opportunities Revenue in Current Quarter
    Read Only: true
    The total revenue of a partner and its hierarchies from won opportunities with expected close date falling in the current quarter.
  • Title: Hierarchy MDF Utilization
    Read Only: true
    User Approved Budget Amount of a partner or its hierarchies .
  • Title: Hierarchy Won Opportunities Revenue
    Read Only: true
    Sum of the revenue from won opportunities of a partner and it's hierarchies.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The session login associated to the user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The user who last updated the opportunity record.
  • Links
  • Title: Approved MDF Claims
    Read Only: true
    Count of the MDF Claims of a Partner that are approved.
  • Title: Open MDF Claims
    Read Only: true
    Count of the open MDF Claims pending for approval of a Partner.
  • Title: Open MDF Requests
    Read Only: true
    Count of the open MDF Requests of a Partner.
  • Title: Open Opportunities
    Read Only: true
    Count of open opportunities of a partner.
  • Title: Enrollments Pending Approval
    Read Only: true
    Count of Enrollments that are pending for approval of a Partner.
  • Title: Potential Opportunity Revenue
    Read Only: true
    Sum of the potential revenue from open opportunities of a partner.
  • Read Only: true
    The unique identifier of the partner associated with the partner rollup.
  • Title: Approved MDF Claims Amount
    Read Only: true
    Sum of the MDF Claims amount that are approved of a Partner.
  • Title: Open MDF Claims Amount
    Read Only: true
    Sum of the open MDF Claims amount pending for approval of a Partner.
  • Title: Open MDF Requests Amount
    Read Only: true
    Sum of the open MDF Requests amount of a Partner.
  • Title: Total Open Opportunities Revenue for Next Quarter
    Read Only: true
    Total revenue of a Partner from open opportunities with expected close date falling in the next quarter.
  • Title: Total Open Opportunities Revenue in Current Quarter
    Read Only: true
    Total revenue of a Partner from open opportunities with expected close date falling in the current quarter.
  • Title: Total Won Opportunities Revenue in Current Quarter
    Read Only: true
    Total revenue of partner from won opportunities with expected close date falling in the current quarter.
  • Title: MDF Utilization
    Read Only: true
    The budget approved by the user.
  • Read Only: true
    The date on which the record is last updated by user.
  • Title: Won Opportunities Revenue
    Read Only: true
    Sum of the revenue from won opportunities of a partner.
Nested Schema : partners-partnerTeam-item-response
Type: object
Show Source
Nested Schema : partners-productSpecialities-item-response
Type: object
Show Source
Nested Schema : partners-RecordSetLookup-item-response
Type: object
Show Source
Nested Schema : partners-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Boolean type indicating if this action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
  • Title: User Action ID
    The unique system assigned identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique system assigned smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type: array
Title: Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : partners-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique system assigned identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : partners-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
  • Links
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : partners-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : partners-types-item-response
Type: object
Show Source
Links
runAssignment
Back to Top