Create a partner
post
/crmRestApi/resources/11.13.18.05/partners
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AccountDirectorId: integer
(int64)
The unique identifier of the partner account owner.
-
accountTeamMembers: array
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. -
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
addresses: array
Addresses
Title:
Addresses
The addresses resource is used to view, create, update, and delete addresses of a partner. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address of the partner. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AnnualRevenue: number
Title:
Annual Revenue
The partner company's annual revenue. -
Assessment: array
Assessments
Title:
Assessments
The assessments resource is used to view, create, update, and delete the assessment of a partner. -
attachments: array
Attachments
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address of the partner. -
BusinessScope: string
Title:
Business Scope
Maximum Length:20
The physical class of business in which a business participates, such as local, national, or international. -
CeoName: string
Title:
Chief Executive Name
Maximum Length:240
The name of the chief executive officer of the partner. -
certifications: array
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. -
City: string
Title:
City
Maximum Length:60
The city of the identifying address. -
CompanyNumber: string
Title:
Partner Number
Maximum Length:30
The alternate key identifier of the partner's company. -
ComplianceReviewedDate: string
(date)
Title:
Compliance Reviewed Date
The date when the compliance review that determines the partner's compliance status was last completed. -
ComplianceStatus: string
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. -
contactPoints: array
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. -
contacts: array
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. -
ControlYr: number
Title:
Organization Control Year
The year when current ownership gained control. -
CorpCurrencyCode: string
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. -
Country(required): string
Title:
Country
Maximum Length:2
The country of the address. Review the list of countries using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CurrencyCode: string
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. -
DbRating: string
Title:
D&B Credit Rating
Maximum Length:5
The Dun & Bradstreet credit rating. -
DUNSNumberC: string
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. -
EligibleForPublicProfile(required): string
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. -
EmailAddress(required): string
Title:
Email
Maximum Length:320
The e-mail address of the contact point. -
EmailFormat: string
Title:
Email Format
Maximum Length:30
Indicates the preferred format for e-mail addressed to this address, such as HTML or ASCII. -
EmployeesTotal: number
Title:
Number of Employees
The total number of employees. -
expertises: array
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. -
FaxNumber: string
Title:
Phone
Maximum Length:40
The fax number of partner organization. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
geographies: array
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. -
HomeCountry: string
Title:
Home Country
Maximum Length:2
The home country of the partner. -
IndstClassCategory(required): string
Title:
Classification Category
Maximum Length:255
The classification category of the industry to which the partner belongs. -
IndstClassCode(required): string
Title:
Classification Code
The classification code of the industry to which the partner belongs. -
industries: array
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. -
IsAccountFlag: boolean
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. -
IsSelfRegisteredPartner: string
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. -
JgzzFiscalCode: string
Title:
Taxpayer Identification Number
Maximum Length:20
The tax identification number of the partner. -
Latitude: number
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. -
LineOfBusiness: string
Title:
Line of Business
Maximum Length:240
The type of business activities performed at this site. -
Longitude: number
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. -
notes: array
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. -
OpportunitiesWonPriorYear: number
Title:
Opportunities Won Prior Year
The opportunities that the partner sales representatives closed and won in the prior fiscal year. -
OpportunitiesWonYTD: number
Title:
Opportunities Won Year to Date
The opportunities that the partner sales representatives closed and won in the current fiscal year-to-date. -
OrganizationName(required): string
Title:
Organization Name
Maximum Length:360
The name of the partner. -
OrganizationSize: string
Title:
Organization Size
Maximum Length:30
The size of the organization based on its revenue, number of employees, and so on. -
ParentPartnerPartyId: integer
(int64)
Title:
Parent Partner Party ID
The unique identifier of the parent partner party. -
ParentPartnerPartyNumber: string
Title:
Parent Partner Company Number
Maximum Length:30
The alternate key identifier of the parent partner party. -
partnerAnnouncements: array
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. -
PartnerLevel: string
Title:
Partner Level
Maximum Length:50
The relative tier of the partner. -
PartnerSummary: string
Title:
Partner Summary
Maximum Length:4000
A brief description of the partner company. -
PartyId: integer
(int64)
The unique identifier of the partner.
-
PartyNumber(required): string
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. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code of the telephone number. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
PhoneExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
PhoneLineType: string
Title:
Type
Maximum Length:30
Default Value:GEN
The lookup code for the type of phone line, such as general, fax, inbound, or outbound. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
A telephone number formatted in the local format. The number should not include area code, country code, or extension. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PreferredContactPersonId: integer
(int64)
Title:
Primary Contact Party ID
The unique identifier of the preferred contact person for this partner. -
PreferredFunctionalCurrency: string
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. -
PrincipalName: string
Title:
Principal Name
Maximum Length:240
The name of the highest ranking person in the organization. -
productSpecialities: array
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. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
PublicAddressId: integer
(int64)
The unique identifier of the public address.
-
PublicContactId: integer
(int64)
The unique identifier of the public contact of the partner company.
-
PublicEmailId: integer
(int64)
The unique identifier of the public email id.
-
PublicFaxId: integer
(int64)
The unique identifier of the public fax number for the partner company.
-
PublicPhoneId: integer
(int64)
The unique identifier of the public phone number.
-
PublicStatus(required): string
Title:
Public Status
Maximum Length:50
The status of approval of public profile. -
RawPhoneNumber: string
Title:
Phone
Maximum Length:60
The raw phone number. -
RecordSetLookup: array
Record Set Lookup
Title:
Record Set Lookup
The recordset lookup resource lets you create, update and delete a recortset lookup. -
RunDataSyncFlag: boolean
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. -
smartActions: array
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. -
SolutionOverview: string
Title:
Solution Overview
Maximum Length:4000
The overview description of partner solutions. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
State: string
Title:
State
Maximum Length:60
The state element of the address. -
Status: string
Title:
Status
Maximum Length:50
The status of the partner's relationship with the organization. This value is maintained by the channel manager. -
StockSymbol: string
Title:
Stock Symbol
Maximum Length:20
The corporate stock symbol of the organization as listed in stock exchanges. -
Synergy: string
Maximum Length:
4000
The description of the value of the partnership between the organization and partner. -
TierId: integer
(int64)
Title:
Tier
The unique identifier of the tier that the partner belongs to. -
types: array
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. -
URL(required): string
Title:
URL
Maximum Length:2000
The URL for the partner's web presence. -
WebType: string
Title:
Protocol
Maximum Length:60
Default Value:HTTP
The prefix class to a web address, such as FTP or HTTP. -
YearEstablished: integer
(int32)
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 : 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 : schema
Type:
Show Source
object
-
AccessLevelCode: string
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. -
AssignmentTypeCode: string
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. -
MemberFunctionCode: string
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. -
OrganizationRole: string
Title:
Title
The role of the resource in the organization. -
OwnerIndicator: string
Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.
-
PartnerAccountResourceId: integer
(int64)
Title:
Partner Account Resource ID
The unique identifier of the party that owns the partner. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
ResourceId: integer
(int64)
Title:
Account Team Member
The unique identifier of the sale profile of the resource.
Nested Schema : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressNumber: string
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. -
AddressType: string
Title:
Type
The lookup code for the type of address, such as billing address, shipping address etc. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
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. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
CorpCurrencyCode: string
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. -
Country: string
Title:
Country
Maximum Length:2
The country of the address. Review the list of countries using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
The module that created the address record. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code 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. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the partner associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
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. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
SourceSystem: string
The identifier of the record from external source system.
-
SourceSystemReferenceValue: string
The name of the external source system.
-
State: string
Title:
State
Maximum Length:60
The state of the address. -
ValidatedFlag: boolean
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 : partners-Assessment-item-post-request
Type:
Show Source
object
-
AssessAnswerGroups: array
Assessment Answer Groups
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment. -
AssessedLanguage: string
Title:
Assessment Language
Maximum Length:4
Default Value:US
The language of the assessment. -
AssessedObjectId(required): integer
(int64)
Title:
Assessed Object ID
The unique identifier of the assessed business object. -
AssessedObjTypeCode(required): string
Title:
Object Type Code
Maximum Length:30
The code indicating the type of the assessed business object. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of an assessment. -
AssessmentScore: integer
(int64)
Title:
Score
Default Value:0
The calculated score of assessment. -
AssessTemplateId(required): integer
(int64)
Title:
Template Name
The unique identifier of the assessment template that served as the source of this assessment. -
BusinessUnit: integer
(int64)
Title:
Business Unit
The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
Name(required): string
Title:
Name
Maximum Length:255
The name of the assessment. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE. -
TemplateName: string
Title:
Template
The name of the assessment template. -
TemplateType: string
Title:
Template Type
The type of the assessment template associated with the assessment. -
TotalAnswered: number
Title:
Total Questions Answered
The number of questions answered in the assessment. -
TotalQuestions: number
Title:
Total Questions
The total number of questions to be answered in the assessment.
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-post-request
Type:
Show Source
object
-
AssessAnswerGroupId: integer
(int64)
The unique identifier of the answer group.
-
AssessmentAnswer: array
AssessmentAnswer
-
AssessmentId(required): integer
(int64)
The unique identifier of the assessment associated with answer group.
-
AttributeGroupId(required): integer
(int64)
The unique identifier of the question group of the associated template.
Nested Schema : partners-Assessment-AssessAnswerGroups-AssessmentAnswer-item-post-request
Type:
Show Source
object
-
Answered: string
Indicates if the question is answered or not.
-
AnswerId: integer
(int64)
The unique identifier of the assessments associated with answer.
-
AssessmentId: integer
(int64)
The unique identifier of the assessment answer.
-
AttributeGroupId: integer
(int64)
Title:
Question Group
The unique identifier of the question group associated with assessment answer. -
AttributeId: integer
(int64)
Title:
Question
The unique identifier of the question associated with assessment answer. -
AttributeValueId: integer
(int64)
Title:
Response
The unique identifier of the response. -
Comments: string
Title:
Comments
Maximum Length:1500
The assessment runtime comments entered by end user. -
HasComments: string
Indicates if the comments are present or not.
Nested Schema : partners-attachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
CertificationCode: string
Title:
Certification
Maximum Length:30
The code indicating the type of the certification. For example, CERTIFIED_SPECIALIST, or CERTIFIED_ARCHITECT. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerMultivalLovId: integer
(int64)
Title:
Certification ID
The unique identifier for partner certifications.
Nested Schema : partners-contactPoints-item-post-request
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. Note: This is an internal attribute and should not be used. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of the contact point such as EMAIL or PHONE. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The module that created the contact point record. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
Indicates whether the contact point is not preferred for contact.
-
DoNotContactReason: string
Indicates the reason for "Do Not Contact" preference.
-
EmailAddress: string
Maximum Length:
255
The e-mail address in the contact point. -
EmailPurpose: string
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. -
ObjectVersionNumber: integer
(int32)
The object version number. (This is an internal attribute and should not be used)
-
PartyId: integer
(int64)
The unique identifier of the party of the partner company.
-
PartyNumber: string
The party number of the partner company.
-
PartySourceSystem: string
The name of the external source system.
-
PartySourceSystemReferenceValue: string
The identifier of the record from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code of the phone number in the contact point. -
PhoneCountryCode: string
Maximum Length:
255
The phone country code of the phone number in the contact point. -
PhoneExtension: string
Maximum Length:
255
The phone extension of the phone number in the contact point. -
PhoneNumber: string
Maximum Length:
255
The phone number in the contact point. -
PhonePurpose: string
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. -
PhoneType: string
The type of the phone number in the contact point. For example: "FAX" or "WORK" determines the type of the phone number.
-
PreferenceRequestedBy: string
Title:
Preference Requested By
The list of values indicating the preference requested. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the contact point is primary. -
RawPhoneNumber: string
Maximum Length:
255
The raw phone number in the contact point. -
SocialNetworkId: string
The social network identifier. Note: This is an internal attribute and should not be used.
-
SocialNetworkName: string
The social network name. Note: This is an internal attribute and should not be used.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL in the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The list of values indicating the purpose of the social network. -
WebPurpose: string
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 : schema
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith. -
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address of the contact. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressType: string
Title:
Address Type
The lookup code for the type of address, such as billing address, shipping address etc. -
attachments: array
Attachments
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address of the contact. -
CertificationLevel: string
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. -
CertificationReasonCode: string
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. -
City: string
Title:
City
Maximum Length:60
The city element of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The textual comments about a contact. -
ContactName: string
Title:
Name
Maximum Length:450
The derived name of the contact. -
Country(required): string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreateUserAccountFlag: boolean
Indicates whether the user account should be created. This should not be used currently.
-
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
Department: string
Title:
Department
Maximum Length:60
The free form text used to name the department for the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates 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. -
DoNotContactFlag: boolean
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. -
DoNotEmailFlag: boolean
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. -
DoNotMailFlag: boolean
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. -
EmailAddress(required): string
Title:
Email
Maximum Length:320
The e-mail address of the partner contact. -
FavoriteContactFlag: boolean
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. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
IsAccountContactFlag: boolean
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. -
isSelfRegistration: string
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. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the primary contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute. -
Latitude: number
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. -
Longitude: number
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. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ManagerPartyId: integer
Title:
Manager Party ID
The unique identifier of the manager party of the partner contact. -
ManagerPartyNumber: string
Maximum Length:
30
The party number of the manager of the partner contact. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobileAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for partner contact's mobile phone. -
MobileCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s mobile phone number, such as 33 for France. -
MobileExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
MobileNumber: string
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. -
NamedFlag: boolean
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. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix. -
PartnerCompanyNumber(required): string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerPartyId(required): integer
(int64)
The unique identifier of the party associated with the partner.
-
PartyId: integer
(int64)
The unique identifier of the partner contact party generated by the system during creation.
-
PartyNumber(required): string
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. -
PersonPreNameAdjunct: string
Title:
Prefix
Maximum Length:30
The title or the salutary introduction for a contact, such as Mr., Herr, and so on. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PreferredContactMethod: string
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. -
PreferredFunctionalCurrency: string
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. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
PrimaryAddressId: integer
(int64)
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.
-
PrimaryFlag: boolean
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. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease 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. -
RoleCode: string
Maximum Length:
30
The role code of the partner contact. -
RoleId: integer
(int64)
Title:
Role ID
The unique identifier of the resource role of the partner contact. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the 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. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
State: string
Title:
State
Maximum Length:60
The state element of the address. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
Type: string
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. -
userdetails: array
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. -
Username: string
The user name of the account for the partner contact. This should not be used currently.
-
WorkPhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for the partner contact's work phone. -
WorkPhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s work phone number, such as 33 for France. -
WorkPhoneExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
WorkPhoneNumber: string
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 : 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 : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
Username: string
Title:
User Name
The name of the user account of the partner contact.
Nested Schema : partners-expertises-item-post-request
Type:
Show Source
object
-
ExpertiseCode: string
Maximum Length:
30
The code indicating the expertise of the partner. For example, COMPUTER_HARDWARE, or MANAGEMENT_CONSULTING. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerMultivalLovId: integer
(int64)
Title:
Expertise ID
The unique identifier for partner expertise.
Nested Schema : partners-geographies-item-post-request
Type:
Show Source
object
-
GeographyId: string
Maximum Length:
30
The unique identifier of the geography being served. -
GeographyName: string
Title:
Geography Served
Maximum Length:360
The name of the geography being served. -
OwnerId: integer
(int64)
The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.
-
PartnerDimMembersId: integer
(int64)
Title:
Geography ID
The unique identifier for the partner geography .
Nested Schema : partners-industries-item-post-request
Type:
Show Source
object
-
ClassificationCategory: string
Maximum Length:
30
The classification category of the industry being served. -
ClassificationCode: string
Title:
Partner Type
Maximum Length:30
The code indicating the type of the industry being served. -
ClassificationName: string
Maximum Length:
360
The display name of the classification of the industry being served. -
PartnerDimMembersId: integer
(int64)
Title:
Industry ID
The unique identifier of the industry with the partner.
Nested Schema : partners-notes-item-post-request
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency 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. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the partner note. -
SourceObjectCode: string
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. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
Nested Schema : partners-productSpecialities-item-post-request
Type:
Show Source
object
-
PartnerDimMembersId: integer
(int64)
Title:
Specialty ID
The unique identifier of the specialty with the partner. -
ProductId: string
Maximum Length:
30
The unique identifier associated with a product specialty. -
ProductName: string
Title:
Focus Area
Maximum Length:360
The name of the product specialty.
Nested Schema : partners-smartActions-item-post-request
Type:
Show Source
object
-
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:1024
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel(required): string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity(required): string
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. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
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. -
UpdateOfAttributes: string
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. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName(required): string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : partners-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object
-
Binding: string
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. -
MandatoryFlag: boolean
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. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
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. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:250
The value assigned to the value property of a name-value pair. -
ValueStruct: string
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-post-request
Type:
Show Source
object
-
Binding: string
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. -
SystemActionFlag: boolean
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. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : partners-types-item-post-request
Type:
Show Source
object
-
DimSubtypeCode: string
Maximum Length:
30
The code indicating a specific type of item within the dimension code. For example, for the products dimension there could be product items and product categories. -
IntegrationId: string
Maximum Length:
80
The unique identifier used for integration purposes. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerDimMembersId: integer
(int64)
The unique identifier for the partner type.
-
PartnerTypeCode: string
Title:
Partner Type
Maximum Length:30
The code indicating the partner type. For example, CCP, or ESP. -
PartnerTypeName: string
Title:
Type
Maximum Length:360
The name of the partner type, such as Value Added Reseller.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : partners-item-response
Type:
Show Source
object
-
AccountDirectorId: integer
(int64)
The unique identifier of the partner account owner.
-
accountTeamMembers: array
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. -
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
addresses: array
Addresses
Title:
Addresses
The addresses resource is used to view, create, update, and delete addresses of a partner. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address of the partner. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AnnualRevenue: number
Title:
Annual Revenue
The partner company's annual revenue. -
Assessment: array
Assessments
Title:
Assessments
The assessments resource is used to view, create, update, and delete the assessment of a partner. -
attachments: array
Attachments
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address of the partner. -
BusinessScope: string
Title:
Business Scope
Maximum Length:20
The physical class of business in which a business participates, such as local, national, or international. -
CeoName: string
Title:
Chief Executive Name
Maximum Length:240
The name of the chief executive officer of the partner. -
certifications: array
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. -
City: string
Title:
City
Maximum Length:60
The city of the identifying address. -
CompanyNumber: string
Title:
Partner Number
Maximum Length:30
The alternate key identifier of the partner's company. -
ComplianceReviewedDate: string
(date)
Title:
Compliance Reviewed Date
The date when the compliance review that determines the partner's compliance status was last completed. -
ComplianceStatus: string
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. -
contactPoints: array
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. -
contacts: array
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. -
ControlYr: number
Title:
Organization Control Year
The year when current ownership gained control. -
CorpCurrencyCode: string
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. -
Country: string
Title:
Country
Maximum Length:2
The country of the address. Review the list of countries using the Manage Geographies task. -
CountryName: string
Title:
Country
Read Only:true
The name of the country associated with the partner company. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the record was created. -
CurrencyCode: string
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. -
DbRating: string
Title:
D&B Credit Rating
Maximum Length:5
The Dun & Bradstreet credit rating. -
DUNSNumberC: string
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. -
EligibleForPublicProfile: string
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. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the contact point. -
EmailFormat: string
Title:
Email Format
Maximum Length:30
Indicates the preferred format for e-mail addressed to this address, such as HTML or ASCII. -
EmployeesTotal: number
Title:
Number of Employees
The total number of employees. -
expertises: array
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. -
FaxNumber: string
Title:
Phone
Maximum Length:40
The fax number of partner organization. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address of the partner. -
geographies: array
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. -
HomeCountry: string
Title:
Home Country
Maximum Length:2
The home country of the partner. -
IndstClassCategory: string
Title:
Classification Category
Maximum Length:255
The classification category of the industry to which the partner belongs. -
IndstClassCode: string
Title:
Classification Code
The classification code of the industry to which the partner belongs. -
industries: array
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. -
IndustryName: string
Title:
Classification Code Meaning
Read Only:true
Maximum Length:80
The classification name of the industry to which the partner belongs. -
IsAccountFlag: boolean
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. -
IsSelfRegisteredPartner: string
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. -
JgzzFiscalCode: string
Title:
Taxpayer Identification Number
Maximum Length:20
The tax identification number of the partner. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record is last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the record. -
Latitude: number
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. -
LineOfBusiness: string
Title:
Line of Business
Maximum Length:240
The type of business activities performed at this site. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
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. -
Mailstop: string
Title:
Mail Stop
Read Only:true
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
notes: array
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. -
OpportunitiesWonPriorYear: number
Title:
Opportunities Won Prior Year
The opportunities that the partner sales representatives closed and won in the prior fiscal year. -
OpportunitiesWonYTD: number
Title:
Opportunities Won Year to Date
The opportunities that the partner sales representatives closed and won in the current fiscal year-to-date. -
OrganizationName: string
Title:
Organization Name
Maximum Length:360
The name of the partner. -
OrganizationProfileId: integer
(int64)
Read Only:
true
The unique identifier for the partner profile. -
OrganizationSize: string
Title:
Organization Size
Maximum Length:30
The size of the organization based on its revenue, number of employees, and so on. -
OwnerName: string
Title:
Owner
Read Only:true
Maximum Length:450
The name of the owner of the partner. -
OwnerPartyNumber: string
Read Only:
true
Maximum Length:30
The unique identifier of the owner of the partner company. -
ParentPartnerId: string
Title:
Parent Primary Key 1 Value
Read Only:true
Maximum Length:100
The unique identifier of the parent partner. -
ParentPartnerList: string
Title:
Parent Partner List
Read Only:true
Maximum Length:255
List of all the parent partners till the top node in the partner hierarchy. -
ParentPartnerName: string
Title:
Parent Partner
Read Only:true
The name of the parent partner. -
ParentPartnerOrigSystem: string
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. -
ParentPartnerOrigSystemReference: string
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. -
ParentPartnerPartyId: integer
(int64)
Title:
Parent Partner Party ID
The unique identifier of the parent partner party. -
ParentPartnerPartyNumber: string
Title:
Parent Partner Company Number
Maximum Length:30
The alternate key identifier of the parent partner party. -
partnerAnnouncements: array
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. -
PartnerLevel: string
Title:
Partner Level
Maximum Length:50
The relative tier of the partner. -
PartnerSummary: string
Title:
Partner Summary
Maximum Length:4000
A brief description of the partner company. -
PartyId: integer
(int64)
The unique identifier of the partner.
-
PartyNumber: string
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. -
PhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code of the telephone number. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
PhoneExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
PhoneLineType: string
Title:
Type
Maximum Length:30
Default Value:GEN
The lookup code for the type of phone line, such as general, fax, inbound, or outbound. -
PhoneNumber: string
Title:
Phone
Maximum Length:40
A telephone number formatted in the local format. The number should not include area code, country code, or extension. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PreferredContactPersonId: integer
(int64)
Title:
Primary Contact Party ID
The unique identifier of the preferred contact person for this partner. -
PreferredFunctionalCurrency: string
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. -
PrimaryContactEmailAddress: string
Title:
Contact Email
Read Only:true
Maximum Length:320
The e-mail address of the partners's primary contact. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the partners's primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Registry ID
Read Only:true
Maximum Length:30
The party number of the primary contact of the partner. -
PrimaryContactPhone: string
Title:
Primary Phone
Read Only:true
The phone number of the partner's primary contact. -
PrincipalName: string
Title:
Principal Name
Maximum Length:240
The name of the highest ranking person in the organization. -
productSpecialities: array
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. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
PublicAddress: string
Title:
Public Address
Read Only:true
The public address of the partner company. -
PublicAddressId: integer
(int64)
The unique identifier of the public address.
-
PublicAddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique identifier of the public address. -
PublicContactId: integer
(int64)
The unique identifier of the public contact of the partner company.
-
PublicContactName: string
Title:
Public Contact
Read Only:true
Maximum Length:360
The name of the public contact of the partner company. -
PublicContactPartyNumber: string
Read Only:
true
Maximum Length:30
The party number of the public contact of the partner company. -
PublicEmailAddress: string
Title:
Public Email
Read Only:true
Maximum Length:320
The public e-mail address of the partner company. -
PublicEmailId: integer
(int64)
The unique identifier of the public email id.
-
PublicFaxId: integer
(int64)
The unique identifier of the public fax number for the partner company.
-
PublicFaxNumber: string
Title:
Public Fax
Read Only:true
The public fax number of the partner company. -
PublicPhoneId: integer
(int64)
The unique identifier of the public phone number.
-
PublicPhoneNumber: string
Title:
Public Phone
Read Only:true
The public phone number of the partner company. -
PublicStatus: string
Title:
Public Status
Maximum Length:50
The status of approval of public profile. -
RawPhoneNumber: string
Title:
Phone
Maximum Length:60
The raw phone number. -
RecordSetLookup: array
Record Set Lookup
Title:
Record Set Lookup
The recordset lookup resource lets you create, update and delete a recortset lookup. -
RunDataSyncFlag: boolean
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. -
smartActions: array
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. -
SolutionOverview: string
Title:
Solution Overview
Maximum Length:4000
The overview description of partner solutions. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
SourceType: string
Read Only:
true
The type of the source object such as Opportunities or Partners as defined in the object metadata. -
SSROwnerTableName: string
Read Only:
true
Maximum Length:30
Default Value:HZ_PARTIES
This is an internal system attribute and should never be used. -
State: string
Title:
State
Maximum Length:60
The state element of the address. -
Status: string
Title:
Status
Maximum Length:50
The status of the partner's relationship with the organization. This value is maintained by the channel manager. -
StockSymbol: string
Title:
Stock Symbol
Maximum Length:20
The corporate stock symbol of the organization as listed in stock exchanges. -
Synergy: string
Maximum Length:
4000
The description of the value of the partnership between the organization and partner. -
TierId: integer
(int64)
Title:
Tier
The unique identifier of the tier that the partner belongs to. -
TierName: string
Title:
Tier
Read Only:true
Maximum Length:155
The name of the tier that the partner belongs to. -
TierRanking: integer
(int32)
Title:
Tier
Read Only:true
The tier ranking of the partner company. -
TotalChildPartners: integer
Title:
Total Child Partners
Read Only:true
The total number of direct and indirect child partners in the hierarchy. -
TotalPartnersInHierarchy: integer
Title:
Total Partners in Hierarchy
Read Only:true
The total number of partners in the hierarchy. -
types: array
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. -
UpdateFlag: boolean
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. -
URL: string
Title:
URL
Maximum Length:2000
The URL for the partner's web presence. -
WebType: string
Title:
Protocol
Maximum Length:60
Default Value:HTTP
The prefix class to a web address, such as FTP or HTTP. -
YearEstablished: integer
(int32)
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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:
Show Source
object
-
AccessLevelCode: string
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. -
AssignmentTypeCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the record was created. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the resource. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The formatted version of the address. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberFunctionCode: string
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. -
OrganizationRole: string
Title:
Title
The role of the resource in the organization. -
OwnerIndicator: string
Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.
-
PartnerAccountResourceId: integer
(int64)
Title:
Partner Account Resource ID
The unique identifier of the party that owns the partner. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
ResourceId: integer
(int64)
Title:
Account Team Member
The unique identifier of the sale profile of the resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the resource. -
ResourcePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The party number for the resource of the partner account team.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : partners-addresses-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the address. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressNumber: string
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. -
AddressType: string
Title:
Type
The lookup code for the type of address, such as billing address, shipping address etc. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
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. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
CorpCurrencyCode: string
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. -
Country: string
Title:
Country
Maximum Length:2
The country of the address. Review the list of countries using the Manage Geographies task. -
CountryName: string
Read Only:
true
The name of the country of the partner company. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
The module that created the address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code 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. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiline version of the address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the partner associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
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. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
SourceSystem: string
The identifier of the record from external source system.
-
SourceSystemReferenceValue: string
The name of the external source system.
-
State: string
Title:
State
Maximum Length:60
The state of the address. -
ValidatedFlag: boolean
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-Assessment-item-response
Type:
Show Source
object
-
AssessAnswerGroups: array
Assessment Answer Groups
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment. -
AssessedLanguage: string
Title:
Assessment Language
Maximum Length:4
Default Value:US
The language of the assessment. -
AssessedObjectId: integer
(int64)
Title:
Assessed Object ID
The unique identifier of the assessed business object. -
AssessedObjTypeCode: string
Title:
Object Type Code
Maximum Length:30
The code indicating the type of the assessed business object. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of an assessment. -
AssessmentScore: integer
(int64)
Title:
Score
Default Value:0
The calculated score of assessment. -
AssessTemplateId: integer
(int64)
Title:
Template Name
The unique identifier of the assessment template that served as the source of this assessment. -
BusinessUnit: integer
(int64)
Title:
Business Unit
The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the assessment record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the assessment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the assessment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:255
The name of the assessment. -
RatingFeedback: string
Title:
Feedback
Read Only:true
The feedback mapped to the rating. -
RatingTerm: string
Title:
Rating
Read Only:true
The overall rating of the assessment as configured in the associated assessment template. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE. -
StatusFuse: string
Title:
Status
Read Only:true
The status of the assessment. -
TemplateName: string
Title:
Template
The name of the assessment template. -
TemplateType: string
Title:
Template Type
The type of the assessment template associated with the assessment. -
TotalAnswered: number
Title:
Total Questions Answered
The number of questions answered in the assessment. -
TotalQuestions: number
Title:
Total Questions
The total number of questions to be answered in the assessment.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-Assessment-AssessAnswerGroups-item-response
Type:
Show Source
object
-
AssessAnswerGroupId: integer
(int64)
The unique identifier of the answer group.
-
AssessmentAnswer: array
Assessment Answers
Title:
Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group. -
AssessmentId: integer
(int64)
The unique identifier of the assessment associated with answer group.
-
AttributeGroupId: integer
(int64)
The unique identifier of the question group of the associated template.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
The name of the answer group.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-Assessment-AssessAnswerGroups-AssessmentAnswer-item-response
Type:
Show Source
object
-
Answered: string
Indicates if the question is answered or not.
-
AnswerId: integer
(int64)
The unique identifier of the assessments associated with answer.
-
AssessmentId: integer
(int64)
The unique identifier of the assessment answer.
-
AttributeGroupId: integer
(int64)
Title:
Question Group
The unique identifier of the question group associated with assessment answer. -
AttributeId: integer
(int64)
Title:
Question
The unique identifier of the question associated with assessment answer. -
AttributeName: string
Read Only:
true
Maximum Length:500
The name of the question. -
AttributeValueId: integer
(int64)
Title:
Response
The unique identifier of the response. -
Comments: string
Title:
Comments
Maximum Length:1500
The assessment runtime comments entered by end user. -
HasComments: string
Indicates if the comments are present or not.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseValue: string
Title:
Response
Read Only:true
The response to the question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-certifications-item-response
Type:
Show Source
object
-
CertificationCode: string
Title:
Certification
Maximum Length:30
The code indicating the type of the certification. For example, CERTIFIED_SPECIALIST, or CERTIFIED_ARCHITECT. -
CertificationName: string
Title:
Meaning
Read Only:true
Maximum Length:80
The name of the certification. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerMultivalLovId: integer
(int64)
Title:
Certification ID
The unique identifier for partner certifications.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-contactPoints-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. Note: This is an internal attribute and should not be used. -
ContactPointId: integer
(int64)
Read Only:
true
The unique identifier of the contact point. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of the contact point such as EMAIL or PHONE. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the contact point record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The module that created the contact point record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the contact point record was created. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
Indicates whether the contact point is not preferred for contact.
-
DoNotContactReason: string
Indicates the reason for "Do Not Contact" preference.
-
EmailAddress: string
Maximum Length:
255
The e-mail address in the contact point. -
EmailPurpose: string
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. -
FormattedPhoneNumber: string
Read Only:
true
Maximum Length:255
The formatted phone number in the contact point. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the contact point record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact point record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the contact point record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number. (This is an internal attribute and should not be used)
-
PartyId: integer
(int64)
The unique identifier of the party of the partner company.
-
PartyNumber: string
The party number of the partner company.
-
PartySourceSystem: string
The name of the external source system.
-
PartySourceSystemReferenceValue: string
The identifier of the record from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code of the phone number in the contact point. -
PhoneCountryCode: string
Maximum Length:
255
The phone country code of the phone number in the contact point. -
PhoneExtension: string
Maximum Length:
255
The phone extension of the phone number in the contact point. -
PhoneNumber: string
Maximum Length:
255
The phone number in the contact point. -
PhonePurpose: string
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. -
PhoneType: string
The type of the phone number in the contact point. For example: "FAX" or "WORK" determines the type of the phone number.
-
PreferenceRequestedBy: string
Title:
Preference Requested By
The list of values indicating the preference requested. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the contact point is primary. -
RawPhoneNumber: string
Maximum Length:
255
The raw phone number in the contact point. -
SocialNetworkId: string
The social network identifier. Note: This is an internal attribute and should not be used.
-
SocialNetworkName: string
The social network name. Note: This is an internal attribute and should not be used.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL in the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The list of values indicating the purpose of the social network. -
WebPurpose: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-contacts-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith. -
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address of the contact. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressType: string
Title:
Address Type
The lookup code for the type of address, such as billing address, shipping address etc. -
attachments: array
Attachments
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address of the contact. -
CertificationLevel: string
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. -
CertificationReasonCode: string
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. -
City: string
Title:
City
Maximum Length:60
The city element of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The textual comments about a contact. -
ContactName: string
Title:
Name
Maximum Length:450
The derived name of the contact. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
CountryName: string
Read Only:
true
The name for the country of the partner company. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreateUserAccountFlag: boolean
Indicates whether the user account should be created. This should not be used currently.
-
CreationDate: string
(date-time)
Read Only:
true
The date and time the record was created. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
Department: string
Title:
Department
Maximum Length:60
The free form text used to name the department for the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates 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. -
DoNotContactFlag: boolean
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. -
DoNotEmailFlag: boolean
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. -
DoNotMailFlag: boolean
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. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the partner contact. -
FavoriteContactFlag: boolean
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. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The formatted address of the partner contact. -
FormattedMobileNumber: string
Title:
Phone Number
Read Only:true
The formatted mobile phone number information. -
FormattedWorkPhoneNumber: string
Title:
Phone Number
Read Only:true
The formatted work phone number information. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
IsAccountContactFlag: boolean
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. -
isSelfRegistration: string
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. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the primary contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the record. -
Latitude: number
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
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. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ManagerName: string
Title:
Manager
Read Only:true
Maximum Length:255
The name of the manager of partner contact. -
ManagerPartyId: integer
Title:
Manager Party ID
The unique identifier of the manager party of the partner contact. -
ManagerPartyNumber: string
Maximum Length:
30
The party number of the manager of the partner contact. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobileAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for partner contact's mobile phone. -
MobileCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s mobile phone number, such as 33 for France. -
MobileExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
MobileNumber: string
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. -
NamedFlag: boolean
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. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the partner associated with the contact. -
PartnerPartyId: integer
(int64)
The unique identifier of the party associated with the partner.
-
PartyId: integer
(int64)
The unique identifier of the partner contact party generated by the system during creation.
-
PartyNumber: string
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. -
PersonPreNameAdjunct: string
Title:
Prefix
Maximum Length:30
The title or the salutary introduction for a contact, such as Mr., Herr, and so on. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PreferredContactMethod: string
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. -
PreferredFunctionalCurrency: string
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. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
PrimaryAddressId: integer
(int64)
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.
-
PrimaryContactPartyId: integer
(int64)
Read Only:
true
The party identifier of the primary contact of the partner. -
PrimaryFlag: boolean
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. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease 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. -
RoleCode: string
Maximum Length:
30
The role code of the partner contact. -
RoleId: integer
(int64)
Title:
Role ID
The unique identifier of the resource role of the partner contact. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:255
The name of the resource role for partner contact. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the 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. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
State: string
Title:
State
Maximum Length:60
The state element of the address. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
Type: string
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. -
userdetails: array
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. -
Username: string
The user name of the account for the partner contact. This should not be used currently.
-
WorkPhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for the partner contact's work phone. -
WorkPhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s work phone number, such as 33 for France. -
WorkPhoneExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
WorkPhoneNumber: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-contacts-userdetails-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserAccountStatus: string
Title:
User Account Request Status
Read Only:true
The status of the user account of the partner contact. -
Username: string
Title:
User Name
The name of the user account of the partner contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-expertises-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
ExpertiseCode: string
Maximum Length:
30
The code indicating the expertise of the partner. For example, COMPUTER_HARDWARE, or MANAGEMENT_CONSULTING. -
ExpertiseName: string
Title:
Meaning
Read Only:true
Maximum Length:80
The display name of the partner expertise. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerMultivalLovId: integer
(int64)
Title:
Expertise ID
The unique identifier for partner expertise.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-geographies-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DimensionMemberName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the geography served. -
GeographyId: string
Maximum Length:
30
The unique identifier of the geography being served. -
GeographyName: string
Title:
Geography Served
Maximum Length:360
The name of the geography being served. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerId: integer
(int64)
The identifier of the entity that owns the relationship with the dimension data. For example, partner profile, partner program, or enrollment.
-
PartnerDimMembersId: integer
(int64)
Title:
Geography ID
The unique identifier for the partner geography .
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-industries-item-response
Type:
Show Source
object
-
ClassificationCategory: string
Maximum Length:
30
The classification category of the industry being served. -
ClassificationCode: string
Title:
Partner Type
Maximum Length:30
The code indicating the type of the industry being served. -
ClassificationName: string
Maximum Length:
360
The display name of the classification of the industry being served. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DimensionMemberName: string
Title:
Name
Read Only:true
Maximum Length:60
The classification name of the industry served. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerDimMembersId: integer
(int64)
Title:
Industry ID
The unique identifier of the industry with the partner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
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. -
CurrencyCode: string
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. -
DeleteFlag: boolean
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. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the note. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type of the note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the partner note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the contact to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of this party. -
SourceObjectCode: string
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. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata. -
UpdateFlag: boolean
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. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-partnerAnnouncements-item-response
Type:
Show Source
object
-
AnnouncementId: integer
(int64)
Read Only:
true
The identifier for the partner annoucement. -
Description: string
(byte)
Read Only:
true
The body or content of the partner annoucement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Subject: string
Read Only:
true
Maximum Length:255
The subject of the partner annoucement.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-productSpecialities-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DimensionMemberName: string
Title:
Name
Read Only:true
Maximum Length:60
The product name of the product specialty. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerDimMembersId: integer
(int64)
Title:
Specialty ID
The unique identifier of the specialty with the partner. -
ProductId: string
Maximum Length:
30
The unique identifier associated with a product specialty. -
ProductName: string
Title:
Focus Area
Maximum Length:360
The name of the product specialty.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-RecordSetLookup-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
-
CreationDate: string
(date-time)
Read Only:
true
-
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the lookup code -
DisplaySequence: integer
(int64)
Title:
Display Sequence
Read Only:true
The sequence in which the lookup code should be displayed. -
EnabledFlag: string
Title:
Enabled Flag
Read Only:true
Maximum Length:1
Indicates if the lookup code is enabled -
EndDateActive: string
(date)
Title:
End Date
Read Only:true
The date when the lookup code is no longer active -
LastUpdateDate: string
(date-time)
Read Only:
true
-
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Code used to identify the lookup -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
Type used to identify the lookup -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Translated display value of the lookup code -
StartDateActive: string
(date)
Title:
Start Date
Read Only:true
The date when the lookup code becomes active -
Tag: string
Title:
Tag
Read Only:true
Maximum Length:150
Tag to describe or filter the lookup
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-smartActions-item-response
Type:
Show Source
object
-
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:1024
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
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. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
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. -
UpdateOfAttributes: string
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. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
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. -
UserActionURLBinding: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
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. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
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. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:250
The value assigned to the value property of a name-value pair. -
ValueStruct: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
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. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-types-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the record was created. -
DimSubtypeCode: string
Maximum Length:
30
The code indicating a specific type of item within the dimension code. For example, for the products dimension there could be product items and product categories. -
IntegrationId: string
Maximum Length:
80
The unique identifier used for integration purposes. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerDimMembersId: integer
(int64)
The unique identifier for the partner type.
-
PartnerTypeCode: string
Title:
Partner Type
Maximum Length:30
The code indicating the partner type. For example, CCP, or ESP. -
PartnerTypeName: string
Title:
Type
Maximum Length:360
The name of the partner type, such as Value Added Reseller.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Assessment
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- CountryLookup
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
- finder:
- CurrenciesLOV
-
Parameters:
- finder:
EnabledFlagFinder
- finder:
- OrganizationSizeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_ORGANIZATION_SIZE%2CLookupCode%3D{OrganizationSize}
- finder:
- ParentPartnerLookup
- PartnerComplianceStatusLookup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PARTNER_COMPLIANCE_STATUS%2CBindLookupCode%3D{ComplianceStatus}
- finder:
- PartnerLevelLookup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PARTNER_LEVEL%2CBindLookupCode%3D{PartnerLevel}
- finder:
- PartnerPublicStatusLookup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_PARTNER_PUBLIC_STATUS%2CBindLookupCode%3D{PublicStatus}
- finder:
- PartnerStatusLookup
-
Parameters:
- finder:
LookupTypeStatusFinder
- finder:
- RecordSetLookup
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- ResourcePickerPVO
-
Operation: /crmRestApi/resources/11.13.18.05/resources
- TierLookup
- YesNoLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCH_YES_NO
- finder:
- accountTeamMembers
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- addresses
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- attachments
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- certifications
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- contactPoints
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- contacts
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- expertises
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- geographies
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- industries
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- notes
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- partnerAnnouncements
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- productSpecialities
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- smartActions
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber:
- types
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- CompanyNumber: