Get all sales leads
get
/crmRestApi/resources/11.13.18.05/leads
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- LeadsFinderByContactId: Finds the list of leads with the specified contactId.
Finder Variables:- ContactId; integer; The unique identifier of the Contact.
- SysEffectiveDate; object.
- MklLeadVOAltKey: Finds a lead with the specified LeadNumber.
Finder Variables:- LeadNumber; string; Shows the Lead Number.
- MyLeadsFinder: Finds the leads with the specified values.
Finder Variables:- Name; string; Finds the leads with the specified lead name.
- ResourcePartyIdRest; integer; The unique identifier of the Resource.
- RestCreationDateLower; string; Finds the leads that are created before the date specified.
- RestCreationDateUpper; string; Finds the leads with the specified creation date.
- RestRecordSet; string; Finds the leads with the specified record set value.
- RestStatusCode; string; Finds the leads with the specified status code.
- SysEffectiveDate; object.
- PrimaryKey: Finds the leads by primary key.
Finder Variables:- LeadId; integer; The unique identifier of the Lead.
- LeadsFinderByContactId: Finds the list of leads with the specified contactId.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AILeadScore; number; The AI calculated probability of the lead being converted to an opportunity.
- AcceptedDateTime; string; The date and time when the sales lead is accepted by a resource assigned to it.
- AccountPartyNumber; string; The account number alternate key for referenced customer.
- AssetId; integer; The unique identifier of the asset associated with the sales lead.
- AssetNumber; string; The alternate key identifier of the asset associated with the sales lead.
- AssetSerialNumber; string; The asset serial number associated with the sales lead.
- AssignmentStatusCode; string; The code indicating the current assignment related status for the lead, for example whether the lead is assigned or unassigned.
- BudgetStatus; string; The budget status associated with the Budget Amount.
- CampaignName; string; The name of the campaign associated with this sales lead.
- ChannelType; string; The channel through which a lead contacted the company.
- ConflictId; integer; The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
- ContactPartyNumber; string; The alternate identifier of the primary contact.
- ContactTimezoneCd; string; The preferred time zone of the contact pursued on the lead.
- CreationDate; string; The date and time when this record is created.
- CustomerId; integer; The unique identifier of the Customer. It is a reference to the customer record in the TCA schema.
- CustomerPartyName; string; The name of the customer.
- DealAmount; number; The total amount attributed to a lead.
- EligibleForConversionFlag; boolean; Specifies whether the lead is eligible for conversion to opportunity.
- IBAssetNumber; string; The unique number for the IB asset associated with the sales lead.
- IBAssetSerialNumber; string; The unique serial number for the IB asset associated with the sales lead.
- JobTitle; string; The job title of the sales lead contact.
- LastAssignmentDate; string; The date on which the lead was last reassigned.
- LastUpdateDate; string; The date and time when the lead data was last updated.
- Latitude; number; The latitude information for the lead address. The latitude information for the location is used for spatial proximity and containment purposes.
- LeadAcceptedFlag; boolean; Indicates if the lead has been accepted.
- LeadAging; number; The number of days elapsed since the lead was created.
- LeadCreatedBy; string; The user who created the lead record.
- LeadCreationDate; string; The date when the lead was created.
- LeadId; integer; The unique identifier of the sales lead.
- LeadLastUpdateDate; string; The date when the lead record was last updated.
- LeadLastUpdatedBy; string; The user who last updated the lead record.
- LeadNumber; string; The alternate key identifier of the lead.
- LeadOrigin; string; The origin of the lead.
- Longitude; number; The longitude information for the lead address. The longitude information for the location is used for spatial proximity and containment purposes.
- Name; string; The name of the lead.
- OwnerId; integer; The unique party identifier associated with the owner of this sales lead.
- OwnerPartyName; string; The name of the owner of a sales lead.
- OwnerPartyNumber; string; The alternate owner number key for referenced owner.
- PartnerCompanyNumber; string; The alternate partner number key for the referenced partner company.
- PartnerId; integer; The unique identifier of the primary partner associated with the lead.
- PartnerPartyName; string; The name of the partner associated with the sales lead.
- PartnerProgramNumber; string; The partner program number alternate key for the referenced partner program.
- PrimaryCampaignId; integer; The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object.
- PrimaryCampaignName; string; The name of the primary campaign of the lead.
- PrimaryCampaignNumber; string; The alternate identifier for primary campaign of the lead.
- PrimaryCompetitorName; string; The name of the primary competitor of the lead.
- PrimaryCompetitorPartyId; integer; The unique identifier of the primary competitor of the lead. It is a reference key to competitor object.
- PrimaryCompetitorPartyNumber; string; The alternate identifier for primary competitor of the lead.
- PrimaryContactAddress1; string; The first line of address associated with the primary contact of the lead.
- PrimaryContactAddress2; string; The second line of address associated with the primary contact of the lead.
- PrimaryContactCity; string; The city where the primary contact of the lead is located.
- PrimaryContactCountry; string; The country where the primary contact of the lead is located.
- PrimaryContactCounty; string; The county where the primary contact of the lead is located.
- PrimaryContactEmailAddress; string; The Email address for the primary sales lead contact on the lead.
- PrimaryContactId; integer; The unique identifier of the sales lead contact marked as a primary lead contact.
- PrimaryContactPartyName; string; The name associated with the primary lead contact.
- PrimaryContactPersonFirstName; string; The first name of the primary contact for a lead.
- PrimaryContactPersonLastName; string; The last name of the primary contact for a lead.
- PrimaryContactPersonMiddleName; string; The middle name of the primary contact for a lead.
- PrimaryContactPostalCode; string; The zip code where the primary contact of the lead is located.
- PrimaryContactState; string; The state where the primary contact of the lead is located.
- PrimaryInventoryItemNumber; string; The alternate key for referenced the primary inventory item.
- PrimaryPhoneNumber; string; The primary phone number for the sales lead contact.
- PrimaryProductGroupReferenceNumber; string; The alternate key for the referenced primary product group.
- ProductGroupName; string; The name of the product group if this record represents a product group.
- Rank; string; The rank associated with this sales lead.
- RawPrimaryPhoneNumber; string; The raw value of the lead primary phone number.
- ReassignReasonCode; string; The code indicating the reason for reassigning the lead. A list of valid values is defined in the lookup ReassignVA.
- RecordSet; string; The record visibility filters for lead search based on the resource and the leads to which the resource is associated to. The set is a group of lead records considered as the base group before other search criteria is used to further refine the search results.
- RegistrationNumber; string; The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.
- RegistrationStatus; string; The approval Status of the sales lead. This is a deal specific attribute.
- RegistrationType; string; The registration type of the sales lead. This is a deal specific attribute.
- RejectReasonCode; string; The code indicating the reason for rejecting the lead. A list of valid values is defined in the lookup RejectReasonVA.
- RetireReasonCode; string; The code indicating the reason for retiring the lead. A list of valid values is defined in the lookup RetireReasonVA.
- SalesTargetLeadStage; string; The lead's current stage in the account based selling process.
- Score; integer; The score associated with this sales lead. This score is computed based on the scoring rules.
- SourceCode; string; The marketing source code associated with this sales lead.
- StatusCode; string; The code indicates the current status of the lead. A list of valid values is defined in the lookup StatusCodeVA.
- Timeframe; string; The timeframe associated with this sales lead.
- WorkPhoneNumber; string; The work phone number of the sales lead contact.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : leads
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-item-response
Type:
Show Source
object
-
AcceptedDate: string
(date)
Title:
Accepted Date
Read Only:true
The date on which lead was accepted by a resource assigned to it. -
AcceptedDateTime: string
(date-time)
Title:
Accepted Date
Read Only:true
The date and time when the sales lead is accepted by a resource assigned to it. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The account number alternate key for referenced customer. -
AddrElementAttribute1: string
Title:
Contact Address Attribute 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Contact Address Attribute 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Contact Address Attribute 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Contact Address Attribute 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Contact Address Attribute 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLinesPhonetic: string
Title:
Contact Phonetic Address
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AILeadScore: number
Title:
AI Lead Score
Read Only:true
The AI calculated probability of the lead being converted to an opportunity. -
AllLeadAttachments: array
Sales Leads Attachments
Title:
Sales Leads Attachments
The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead. -
ApprovalDate: string
(date)
Title:
Registration Approval Date
The date on which a partner registered lead is approved by internal channel manager. -
ApprovalDateTime: string
(date-time)
Title:
Registration Approval Date
The date and time when the sales lead is approved. This is only applicable to deal registrations. -
Assessments: array
Lead Qualifications
Title:
Lead Qualifications
The assessments resource is used to view, create and update qualifications of a lead. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of the asset associated with the sales lead. -
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The alternate key identifier of the asset associated with the sales lead. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The asset serial number associated with the sales lead. -
AssignmentStatusCode: string
Title:
Assignment Status
Maximum Length:30
The code indicating the current assignment related status for the lead, for example whether the lead is assigned or unassigned. -
BudgetAmount: number
Title:
Budget Amount
The budget amount associated with this sales lead. -
BudgetCurrencyCode: string
Title:
Budget Currency
Maximum Length:80
The currency code associated with the Budget Amount. This attribute is used by CRM Extensibility framework. 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. -
BudgetStatus: string
Title:
Budget Status
Maximum Length:120
The budget status associated with the Budget Amount. -
Building: string
Title:
Building
Maximum Length:40
The specific building name or number at a given address. -
BusinessUnitId: integer
(int64)
Title:
Business Unit Identifier
The unique identifier of the Business Unit which is associated with the business unit of the sales lead creator. -
CampaignName: string
Title:
Campaign
Read Only:true
Maximum Length:250
The name of the campaign associated with this sales lead. -
ChannelType: string
Title:
Source
Maximum Length:30
The channel through which a lead contacted the company. -
ClassCode1: string
Title:
Industry Classification Code
Maximum Length:30
The auxiliary dimension for the Account. -
ClassCode2: string
Title:
Auxiliary Classification Code 1
Maximum Length:30
The auxiliary dimension for the Account. -
ClassCode3: string
Title:
Auxiliary Classification Code 2
Maximum Length:30
The auxiliary dimension for the Account. -
ClassCode4: string
Title:
Auxiliary Classification Code 3
Maximum Length:30
The auxiliary dimension for the Account. -
ConflictId: integer
(int64)
Title:
Conflict Identifier
Default Value:1
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
ContactDoNotPreference: boolean
Title:
Don't Contact Preference
Maximum Length:30
Indicates the don't contact preference of the sales lead. -
ContactFormattedAddress: string
Title:
Primary Contact Address
Read Only:true
The primary address of a lead's primary contact. -
ContactPartyNumber: string
Title:
Primary Contact Number
Read Only:true
Maximum Length:30
The alternate identifier of the primary contact. -
ContactTimezoneCd: string
Title:
Contact Time Zone
Maximum Length:35
The preferred time zone of the contact pursued on the lead. -
ConvertedDateTime: string
(date-time)
Title:
Converted Date
The date and time when the sales lead is converted to an opportunity. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this lead record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record is created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the lead. This attribute is used by CRM Extensibility framework. 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. -
CustomerId: integer
(int64)
Title:
Customer ID
The unique identifier of the Customer. It is a reference to the customer record in the TCA schema. -
CustomerNeed: string
Title:
Customer Need
Maximum Length:30
The need the lead product serves for the lead customer. -
CustomerPartyName: string
Title:
Account Name
Maximum Length:360
The name of the customer. -
DealAmount: number
Title:
Deal Size
The total amount attributed to a lead. -
DecisionMakerIdentifiedFlag: boolean
Title:
Decision Maker Identified
Maximum Length:120
Default Value:false
Indicates if the decision maker at customer site has been identified. -
DeleteFlag: boolean
Read Only:
true
Indicates if the user has access to delete the record. The default value is false. -
Description: string
Title:
Description
Maximum Length:2000
The description of a sales lead. -
Distance: number
Title:
Distance
Read Only:true
The distance of the lead address from the current location. -
EligibleForConversionFlag: boolean
Title:
Eligible for Conversion
Maximum Length:1
Specifies whether the lead is eligible for conversion to opportunity. -
EnableCreateAccount: string
Title:
Create Account
Maximum Length:1
Indicates whether new account should be created during lead conversion. -
EnableCreateContact: string
Title:
Create Contact
Maximum Length:1
Indicates whether new contact should be created during lead conversion. -
EstimatedCloseDate: string
(date)
Title:
Estimated Close Date
The date when a registered deal is expected to close. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when a sales lead will expire. -
FloorNumber: string
Title:
Contact Address Floor Number
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FollowupTimestamp: string
(date)
Title:
Next Follow-up Date
Indicates when the sales lead needs to be followed up. -
FormattedPhoneNumber1: string
Title:
Contact Phone
Read Only:true
The formatted phone number of the primary contact for the lead. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset
The unique identifier for the IB asset associated with the sales lead. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The unique number for the IB asset associated with the sales lead. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The unique serial number for the IB asset associated with the sales lead. -
Interviews: array
Interviews
Title:
Interviews
The interviews resource is used to view and delete an interview record. -
InventoryItemDescription: string
Title:
Product Item
Maximum Length:240
The description of the product added to a lead. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the sales lead contact. -
LastAssignmentDate: string
(date-time)
Title:
Last Automatic Assignment Date
The date on which the lead was last reassigned. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the lead data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the lead record. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the sales lead record. -
Latitude: number
Title:
Latitude
The latitude information for the lead address. The latitude information for the location is used for spatial proximity and containment purposes. -
LeadAcceptedFlag: boolean
Title:
Accepted
Maximum Length:4
Indicates if the lead has been accepted. -
LeadAging: number
Title:
Age in Days
Read Only:true
The number of days elapsed since the lead was created. -
LeadCampaigns: array
Lead Campaigns
Title:
Lead Campaigns
The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead. -
LeadCompetitors: array
Sales Lead Competitors
Title:
Sales Lead Competitors
The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead. -
LeadCreatedBy: string
Title:
Lead Created By
Maximum Length:64
The user who created the lead record. -
LeadCreationDate: string
(date-time)
Title:
Lead Creation Date
The date when the lead was created. -
LeadId: integer
(int64)
Title:
Lead Identifier
The unique identifier of the sales lead. -
LeadLastUpdateDate: string
(date-time)
Title:
Lead Last Update Date
The date when the lead record was last updated. -
LeadLastUpdatedBy: string
Title:
Lead Last Updated By
Maximum Length:64
The user who last updated the lead record. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate key identifier of the lead. -
LeadOpportunity: array
Opportunities
Title:
Opportunities
The opportunity resource is used to view, create, or modify an opportunity generated from a lead. An opportunity list associated with the lead represents leads that have already been converted to the list of opportunities. -
LeadOrigin: string
Title:
Origin
Maximum Length:30
Default Value:SALES_LEAD
The origin of the lead. -
LeadRollup: array
Lead Rollups
Title:
Lead Rollups
The lead rollups resource is used to view a sales lead rollup. -
leadScoreDetails: array
Lead Score Details
Title:
Lead Score Details
The lead score details resource is used to view the details of lead conversion probability. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
The longitude information for the lead address. The longitude information for the location is used for spatial proximity and containment purposes. -
MklLeadResources: array
Sales Lead Resources
Title:
Sales Lead Resources
The sales lead resources data object (resource) is used to capture a resource associated with the sales lead team. A lead resource is a business object that is used to represent resources who are team members that form part of the lead sales team. -
MklLeadTcMembers1: array
Sales Lead Contacts
Title:
Sales Lead Contacts
The sales lead contacts resource is used to capture a contact associated with the sales lead. -
MklLeadTeam: array
Lead Team
Title:
Lead Team
The lead teams resource is used to view the team members and territory team members associated with a lead. -
MklLeadTerritoryAssoc: array
Sales Lead Territories
Title:
Sales Lead Territories
The sales lead territories resource is used to view the associated sales lead territories. -
MklProdAssoc1: array
Sales Lead Products
Title:
Sales Lead Products
The sales lead products resource is used to capture a product associated with the sales lead. -
Name: string
Title:
Lead Name
Maximum Length:250
The name of the lead. -
Note: array
Notes
Title:
Notes
The note resource is used to capture comments, information, or instructions for a sales lead. -
OpportunityName: string
Title:
Opportunity Name
The name of the opportunity created from converting the lead. -
OpportunityOwnerNumber: string
Title:
Opportunity Owner Number
The alternate identifier for the owner of the opportunity created from converting the lead. -
OrchestrationAssociations: array
Orchestration Associations
Title:
Orchestration Associations
The orchestrations associations resource is used to view, create, update, and delete an orchestration association. -
OrganizationSize: string
Title:
Organization Size
Maximum Length:30
The size of the Organization. -
OrganizationType: string
Title:
Organization Type
Maximum Length:30
The type of the Organization. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique party identifier associated with the owner of this sales lead. -
OwnerPartyName: string
Title:
Owner
Maximum Length:360
The name of the owner of a sales lead. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The alternate owner number key for referenced owner. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The alternate partner number key for the referenced partner company. -
PartnerId: integer
(int64)
Title:
Primary Partner Identifier
The unique identifier of the primary partner associated with the lead. -
PartnerPartyName: string
Title:
Primary Partner
The name of the partner associated with the sales lead. -
PartnerProgramId: integer
(int64)
Title:
Partner Program
The unique identifier for the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute. -
PartnerProgramNumber: string
Title:
Partner Program Number
Maximum Length:30
The partner program number alternate key for the referenced partner program. -
PartnerType: string
Title:
Partner Type
Maximum Length:30
The type of the primary partner associated with this sales lead. This is a deal specific attribute. -
PostalPlus4Code: string
Title:
Postal Code
Maximum Length:10
The four digit extension to the United States Postal ZIP code. -
PrimaryCampaignId: integer
(int64)
Title:
Primary Campaign ID
The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object. -
PrimaryCampaignName: string
Title:
Primary Campaign
The name of the primary campaign of the lead. -
PrimaryCampaignNumber: string
Title:
Primary Campaign Number
Maximum Length:30
The alternate identifier for primary campaign of the lead. -
PrimaryCompetitorName: string
Title:
Primary Competitor
The name of the primary competitor of the lead. -
PrimaryCompetitorPartyId: integer
Title:
Primary Competitor Party ID
The unique identifier of the primary competitor of the lead. It is a reference key to competitor object. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The alternate identifier for primary competitor of the lead. -
PrimaryContactAddress1: string
Title:
Primary Contact Address 1
Maximum Length:240
The first line of address associated with the primary contact of the lead. -
PrimaryContactAddress2: string
Title:
Primary Contact Address 2
Maximum Length:240
The second line of address associated with the primary contact of the lead. -
PrimaryContactAddress3: string
Title:
Primary Contact Address 3
Maximum Length:240
The third line of address associated with the primary contact of the lead. -
PrimaryContactAddress4: string
Title:
Primary Contact Address 4
Maximum Length:240
The fourth line of address associated with the primary contact of the lead. -
PrimaryContactCity: string
Title:
Primary Contact City
Maximum Length:60
The city where the primary contact of the lead is located. -
PrimaryContactCountry: string
Title:
Country
Maximum Length:2
The country where the primary contact of the lead is located. -
PrimaryContactCountryName: string
Title:
Country Name
Read Only:true
The name of the country associated with the primary contact. -
PrimaryContactCounty: string
Title:
Primary Contact County
Maximum Length:60
The county where the primary contact of the lead is located. -
PrimaryContactEmailAddress: string
Title:
Contact Email
Maximum Length:320
The Email address for the primary sales lead contact on the lead. -
PrimaryContactEmailPreference: string
Title:
Email Preference
Maximum Length:30
Indicates if the user can e-mail the lead or not. If the value is True, then the user must not contact the person by e-mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
PrimaryContactEmailVerificationDate: string
(date-time)
Title:
Email Verification Date
The verification date for primary contact email address. -
PrimaryContactEmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The verification status for primary contact email address. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the sales lead contact marked as a primary lead contact. -
PrimaryContactMailPreference: string
Title:
Mail Preference
Maximum Length:30
Indicates if the user can send mail to the lead 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. -
PrimaryContactPartyName: string
Title:
Primary Contact Name
Maximum Length:450
The name associated with the primary lead contact. -
PrimaryContactPersonFirstName: string
Title:
Primary Contact First Name
Maximum Length:150
The first name of the primary contact for a lead. -
PrimaryContactPersonLastName: string
Title:
Primary Contact Last Name
Maximum Length:150
The last name of the primary contact for a lead. -
PrimaryContactPersonMiddleName: string
Title:
Primary Contact Middle Name
Maximum Length:150
The middle name of the primary contact for a lead. -
PrimaryContactPhonePreference: string
Title:
Phone Preference
Maximum Length:30
Indicates if the user can contact the lead or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
PrimaryContactPostalCode: string
Title:
Primary Contact Postal Code
Maximum Length:60
The zip code where the primary contact of the lead is located. -
PrimaryContactProvince: string
Title:
Primary Contact Province
Maximum Length:60
The province where the primary contact of the lead is located. -
PrimaryContactRelationshipId: integer
(int64)
Title:
Primary Contact Relationship ID
The unique identifier of the relationship primary contact has with its parent organization. -
PrimaryContactState: string
Title:
Primary Contact State
Maximum Length:60
The state where the primary contact of the lead is located. -
PrimaryInventoryItemId: integer
(int64)
Title:
Primary Product ID
The unique identifier of the primary product associated with a lead. -
PrimaryInventoryItemNumber: string
Title:
Primary Inventory Item Number
Read Only:true
Maximum Length:300
The alternate key for referenced the primary inventory item. -
PrimaryInventoryOrgId: integer
(int64)
Title:
Primary Product Organization ID
The unique identifier of the organization to which the primary product associated with a lead belongs. -
PrimaryPhoneAreaCode: string
Title:
Primary Phone Area Code
Maximum Length:10
The primary phone area code for the sales lead contact. -
PrimaryPhoneCountryCode: string
Title:
Primary Phone Country Code
Maximum Length:10
The primary phone country code for the sales lead contact. -
PrimaryPhoneNumber: string
Title:
Contact Phone
Maximum Length:40
The primary phone number for the sales lead contact. -
PrimaryPhoneVerificationDate: string
(date-time)
Title:
Primary Phone Verification Date
The verification date for lead primary phone. -
PrimaryPhoneVerificationStatus: string
Title:
Primary Phone Verification Status
Maximum Length:30
The verification status for lead primary phone. -
PrimaryProductGroupId: integer
Title:
Primary Product Group ID
The unique identifier of the primary product group associated with a lead. -
PrimaryProductGroupReferenceNumber: string
Title:
Primary Product Group Reference Number
Maximum Length:50
The alternate key for the referenced primary product group. -
ProductGroupDescription: string
Title:
Product Group Description
Read Only:true
Maximum Length:1000
The description of the product group. -
ProductGroupName: string
Title:
Product Group
Maximum Length:250
The name of the product group if this record represents a product group. -
productGroups: array
Product Groups
Title:
Product Groups
The product groups resource is used to capture the name of the product group associated with the sales lead. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog. -
products: array
Products
Title:
Products
The product resource is used to capture the name of the product associated with the sales lead. -
ProductType: string
Title:
Product Type
The type of the primary product, such as item or product group. -
ProgramName: string
Title:
Partner Program
The name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute. -
Project: string
Title:
Customer Project
Maximum Length:30
The customer project identified for this sales lead. -
QualificationScore: integer
(int64)
Title:
Qualification Score
Read Only:true
Default Value:0
The qualification score for a lead. -
QualifiedDate: string
(date)
Title:
Qualification Date
The date when this sales lead was qualified. -
QualifiedDateTime: string
(date-time)
Title:
Qualification Date
The date and time when the sales lead is qualified. -
Rank: string
Title:
Rank
Maximum Length:30
The rank associated with this sales lead. -
RawPrimaryPhoneNumber: string
Title:
Raw Phone Number
The raw value of the lead primary phone number. -
ReassignComment: string
Title:
Reassign Comments
Maximum Length:1000
The comment provided by a user while requesting the lead reassignment. -
ReassignReasonCode: string
Title:
Reassign Reason
Maximum Length:30
The code indicating the reason for reassigning the lead. A list of valid values is defined in the lookup ReassignVA. -
RecordSet: string
Title:
Record Set
Read Only:true
The record visibility filters for lead search based on the resource and the leads to which the resource is associated to. The set is a group of lead records considered as the base group before other search criteria is used to further refine the search results. -
RegistrationNumber: string
Title:
Registration Number
Maximum Length:120
The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:120
The approval Status of the sales lead. This is a deal specific attribute. -
RegistrationType: string
Title:
Registration Type
Maximum Length:120
The registration type of the sales lead. This is a deal specific attribute. -
RejectByUserId: integer
(int64)
Title:
Reject by User ID
The unique identifier of the sales representative who rejected this sales lead. -
RejectComment: string
Title:
Rejection Comments
Maximum Length:250
The comments provided by the sales representative who rejected this sales lead. -
RejectedDateTime: string
(date-time)
Title:
Rejected Time Stamp
The date and time when the sales lead is rejected. -
RejectReasonCode: string
Title:
Reject Reason
Maximum Length:30
The code indicating the reason for rejecting the lead. A list of valid values is defined in the lookup RejectReasonVA. -
RetireComment: string
Title:
Retirement Comments
Maximum Length:250
The comments recorded when the sales lead is moved to a retired status. -
RetiredDateTime: string
(date-time)
Title:
Retired Time Stamp
The date and time when the sales lead is moved to a retired status. -
RetireReasonCode: string
Title:
Retire Reason
Maximum Length:30
The code indicating the reason for retiring the lead. A list of valid values is defined in the lookup RetireReasonVA. -
SalesChannel: string
Title:
Sales Channel
Maximum Length:120
The sales channel responsible for following up on this sales lead. -
SalesContents: array
Sales Contents
Title:
Sales Contents
The sales contents resource is used to view, create, update, and delete the sales content associated with a lead. -
SalesTargetLeadEloquaSyncDate: string
(date-time)
Title:
Last Sync to Marketing Date
The date on which the current sales target lead contacts are last synced to Eloqua. -
SalesTargetLeadOptOutComment: string
Title:
Opt-out Comment
Maximum Length:1000
The comments provided by the sales representative who opted out this lead. -
SalesTargetLeadOptOutDate: string
(date-time)
Title:
Opt-out Date
The date of opting out the lead from sales target campaign. -
SalesTargetLeadOptOutReasonCode: string
Title:
Opt-out Reason
Maximum Length:32
The reason for opting out the lead from sales target campaign. -
SalesTargetLeadStage: string
Title:
Stage
Maximum Length:32
The lead's current stage in the account based selling process. -
SalesTargetLeadValidationDueDate: string
(date-time)
Title:
Validation Due Date
The date on which the sales target lead validation is due. -
Score: integer
(int64)
Title:
Score
The score associated with this sales lead. This score is computed based on the scoring rules. -
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. -
SourceCode: string
Title:
Source Code
Maximum Length:30
The marketing source code associated with this sales lead. -
sourceCodes: array
Marketing Source Codes
Title:
Marketing Source Codes
The marketing source code resource is used to track responses and leads generated by each sales and marketing campaigns, and helps gauge the effectiveness of each initiative. A marketing source code is a unique identifier representing a marketing campaign and the underlying treatment and segment or list used within each execution. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:UNQUALIFIED
The code indicates the current status of the lead. A list of valid values is defined in the lookup StatusCodeVA. -
Timeframe: string
Title:
Time Frame
Maximum Length:120
The timeframe associated with this sales lead. -
ToReassignFlag: boolean
Title:
Reassign
Maximum Length:1
Default Value:false
Indicates leads that are either unassigned or have been selected for automatic reassignment. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. The default value is false. -
WorkPhoneAreaCode: string
Title:
Work Phone Area Code
Maximum Length:10
The area code of the work phone associated with the sales lead contact. -
WorkPhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The country code of the work phone associated with the sales lead contact. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the sales lead contact.
Nested Schema : Sales Leads Attachments
Type:
array
Title:
Sales Leads Attachments
The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.
Show Source
Nested Schema : Lead Qualifications
Type:
array
Title:
Lead Qualifications
The assessments resource is used to view, create and update qualifications of a lead.
Show Source
Nested Schema : Interviews
Type:
array
Title:
Interviews
The interviews resource is used to view and delete an interview record.
Show Source
Nested Schema : Lead Campaigns
Type:
array
Title:
Lead Campaigns
The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.
Show Source
Nested Schema : Sales Lead Competitors
Type:
array
Title:
Sales Lead Competitors
The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.
Show Source
Nested Schema : Opportunities
Type:
array
Title:
Opportunities
The opportunity resource is used to view, create, or modify an opportunity generated from a lead. An opportunity list associated with the lead represents leads that have already been converted to the list of opportunities.
Show Source
Nested Schema : Lead Rollups
Type:
array
Title:
Lead Rollups
The lead rollups resource is used to view a sales lead rollup.
Show Source
Nested Schema : Lead Score Details
Type:
array
Title:
Lead Score Details
The lead score details resource is used to view the details of lead conversion probability.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sales Lead Resources
Type:
array
Title:
Sales Lead Resources
The sales lead resources data object (resource) is used to capture a resource associated with the sales lead team. A lead resource is a business object that is used to represent resources who are team members that form part of the lead sales team.
Show Source
Nested Schema : Sales Lead Contacts
Type:
array
Title:
Sales Lead Contacts
The sales lead contacts resource is used to capture a contact associated with the sales lead.
Show Source
Nested Schema : Lead Team
Type:
array
Title:
Lead Team
The lead teams resource is used to view the team members and territory team members associated with a lead.
Show Source
Nested Schema : Sales Lead Territories
Type:
array
Title:
Sales Lead Territories
The sales lead territories resource is used to view the associated sales lead territories.
Show Source
Nested Schema : Sales Lead Products
Type:
array
Title:
Sales Lead Products
The sales lead products resource is used to capture a product associated with the sales lead.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The note resource is used to capture comments, information, or instructions for a sales lead.
Show Source
Nested Schema : Orchestration Associations
Type:
array
Title:
Orchestration Associations
The orchestrations associations resource is used to view, create, update, and delete an orchestration association.
Show Source
Nested Schema : Product Groups
Type:
array
Title:
Product Groups
The product groups resource is used to capture the name of the product group associated with the sales lead. A product group is a business object that groups related products, so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
Show Source
Nested Schema : Products
Type:
array
Title:
Products
The product resource is used to capture the name of the product associated with the sales lead.
Show Source
Nested Schema : Sales Contents
Type:
array
Title:
Sales Contents
The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.
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 : Marketing Source Codes
Type:
array
Title:
Marketing Source Codes
The marketing source code resource is used to track responses and leads generated by each sales and marketing campaigns, and helps gauge the effectiveness of each initiative. A marketing source code is a unique identifier representing a marketing campaign and the underlying treatment and segment or list used within each execution.
Show Source
Nested Schema : leads-AllLeadAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : 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 : leads-Assessments-item-response
Type:
Show Source
object
-
AssessAnswerGroups: array
Assessment Answer Groups
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view question groups in an assessment. -
AssessedLanguage: string
Title:
Assessment Language
Maximum Length:4
Default Value:US
The language used for qualification of the lead. -
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 assessed business object. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of a lead qualification. -
AssessmentScore: integer
(int64)
Title:
Score
Default Value:0
The calculated score of the lead qualification. -
AssessTemplateId: integer
(int64)
Title:
Template Name
The unique identifier of the lead qualification template that served as the source of this qualification. -
BusinessUnit: integer
(int64)
Title:
Business Unit
The business unit required to create a lead qualification and corresponds to the business unit of business object. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the lead qualification template record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the lead qualification template record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the lead qualification template 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 lead qualification. -
RatingFeedback: string
Title:
Feedback
Read Only:true
The feedback mapped to the rating of the lead. -
RatingTerm: string
Title:
Rating
Read Only:true
The overall rating of the qualification as configured in the associated lead qualification template. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE. -
StatusFuse: string
Title:
Status
Read Only:true
The status of the qualification. -
TemplateName: string
Title:
Template
The name of the lead qualification template. -
TemplateType: string
Title:
Template Type
The object type of the lead qualification template associated with the qualification. -
TotalAnswered: number
Title:
Total Questions Answered
The number of questions responded in the qualification. -
TotalQuestions: number
Title:
Total Questions
The total number of questions to be answered in the qualification.
Nested Schema : Assessment Answer Groups
Type:
array
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view 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 : leads-Assessments-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 answer resource is used to view and update a response for a question in a question group. -
AssessmentId: integer
(int64)
The unique identifier of the lead qualification template associated with answer group.
-
AttributeGroupId: integer
(int64)
The unique identifier of the question group of the associated lead qualification 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 answer resource is used to view and update a response for a question in a question group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-Assessments-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 qualification answer.
-
AssessmentId: integer
(int64)
The unique identifier of the lead qualification template associated with answer.
-
AttributeGroupId: integer
(int64)
Title:
Question Group
The unique identifier of the question group associated with the qualification answer. -
AttributeId: integer
(int64)
Title:
Question
The unique identifier of the question associated with the qualification 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 comments entered by the user about the qualification runtime. -
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 of the question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-Interviews-item-response
Type:
Show Source
object
-
AttachmentId: integer
(int64)
Title:
Attachment ID
The identifier for attachment of interview summary. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the interview record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the interview record was created. -
InterviewData: string
(byte)
Title:
Interview Data
The submitted interview data containing questionnaires and responses. -
InterviewDataLang: string
Title:
Interview Data Language
Maximum Length:30
The language in which interview has been submitted. -
InterviewDraft: string
(byte)
Title:
Interview Draft
The draft interview data. This allows a user to continue from the saved draft. -
InterviewId: integer
(int64)
Title:
Interview ID
The unique identifier of interview record. -
InterviewName: string
Title:
Interview Name
Maximum Length:100
The name of the interview. -
InterviewNumber: string
Title:
Interview Number
Maximum Length:30
The public unique identifier of the interview record. -
InterviewStatus: string
Title:
Interview Status
Maximum Length:30
Specifies the status of the interview -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date and time when the interview record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the interview record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Read Only:true
Specifies how many times the row has been updated. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
The unique identifier of the user who created the record. -
OwnerResourceNumber: string
Title:
Owner Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the user who created the record. -
OwnerResourcePartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the user who created the interview record. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
The name of the top level object associated with the interview. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier of top level object associated with the interview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-LeadCampaigns-item-response
Type:
Show Source
object
-
CampaignEndDate: string
(date-time)
Title:
End Date
Read Only:true
The date when marketing integration campaign ends. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign Name
Read Only:true
Maximum Length:100
The campaign to which the current lead belongs. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The alternate identifier of the campaign number. -
CampaignStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The date when marketing integration campaign starts. -
CampaignStatus: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:ORA_DRAFT
The status of marketing integration campaign. -
CampaignType: string
Title:
Type
Read Only:true
Maximum Length:30
The type of marketing integration campaign. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the lead campaign record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record is created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the lead campaign data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the lead campaign record. -
LeadCampaignId: integer
(int64)
Title:
Lead Campaign ID
Read Only:true
The unique identifier of the lead campaign. -
LeadCampaignNumber: string
Title:
Lead Campaign Number
Maximum Length:30
The alternate identifier of the lead campaign. Public surrogate key for this table. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead. It is the reference key to lead header. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate identifier for the current lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the campaign is primary for the lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-LeadCompetitors-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
Indicates the comments of the competitor associated with the lead. -
CompetitorPartyId: integer
(int64)
Title:
Competitor Party ID
The unique identifier of the competitor. -
CompetitorPartyName: string
Title:
Competitor Party Name
Read Only:true
Maximum Length:360
The name of the competitor of the lead. -
CompetitorPartyNumber: string
Title:
Competitor Party Number
Read Only:true
Maximum Length:30
The alternate identifier for competitor of the lead. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the lead competitor record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the lead competitor data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the lead competitor record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the sales lead competitor record. -
LeadCompetitorId: integer
(int64)
Title:
Lead Competitor ID
The unique identifier of the lead competitor. -
LeadCompetitorNumber: string
Title:
Lead Competitor Number
Maximum Length:30
The alternate identifier of the lead competitor. Public surrogate key for this table. -
LeadId: integer
(int64)
Title:
Lead Identifier
The unique identifier of the lead. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate key identifier of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: boolean
Title:
PrimaryFlag
Indicates whether the competitor is a primary for the lead. -
ThreatLevelCode: string
Title:
Threat Level Code
Maximum Length:30
Indicates the threat level of the competitor associated with the lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-LeadOpportunity-item-response
Type:
Show Source
object
-
Account: string
Title:
Customer Name
Read Only:true
The account associated with the lead. -
Currency: string
Title:
Currency
Read Only:true
The currency associated with the opportunity revenue amount. -
ExpectedAmount: integer
Title:
Expected Revenue
Read Only:true
The win probability percentage of the revenue amount. -
LeadName: string
Title:
Lead Name
Read Only:true
The lead name used for identifying the lead. -
LeadNumber: string
Title:
Lead Number
Read Only:true
The lead number of the lead from which the opportunity originated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptyCloseDate: string
(date-time)
Title:
Close Date
Read Only:true
The date when the opportunity closes. -
OptyId: integer
Title:
Opportunity ID
Read Only:true
The unique identifier of the opportunity associated with the lead. -
OptyName: string
Title:
Opportunity
Read Only:true
The name of the opportunity associated with the lead. -
OptyNumber: string
Title:
Opportunity Number
Read Only:true
The alternate key identifier of the opportunity associated with the lead. -
OptyStatus: string
Title:
Status
Read Only:true
The status of the opportunity associated with the lead. -
RevenueAmount: integer
Title:
Line Revenue
Read Only:true
The revenue amount of the opportunity associated with the lead. -
SalesStageId: integer
Title:
Sales Stage ID
Read Only:true
The unique identifier of the sales stage of the opportunity associated with the lead. -
SalesStageName: string
Title:
Name
Read Only:true
The name of the sales stage of the opportunity associated with the lead. -
WinProbability: integer
Title:
Win Probability
Read Only:true
The win probability of the opportunity associated with the lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-LeadRollup-item-response
Type:
Show Source
object
-
CallsMade: number
Title:
Total Calls Made
Read Only:true
The total number of outbound calls made in context of the sales lead. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Read Only:true
Maximum Length:15
The corporate currency code for the Sales Lead Rollups. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EmailsSent: number
Title:
Total Emails Sent
Read Only:true
The total number of emails sent in context of the sales lead. -
LastCallMadeDate: string
(date-time)
Title:
Last Call Made
Read Only:true
The date when last outbound call was made in context of the sales lead. -
LastCompletedActivity: string
(date-time)
Title:
Last Completed Activity
Read Only:true
The date of last completed activity for a sales lead. Activity includes task, appointment, and call report. -
LastEmailSentDate: string
(date-time)
Title:
Last Email Sent
Read Only:true
The date when last email was sent in context of the sales lead. -
LastTouchDate: string
(date-time)
Title:
Last Touch Date
Read Only:true
The date of last touch in context of the sales lead. A touch refers to an outbound communication such as email sent or phone call made and so on. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row 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. -
LeadId: integer
(int64)
Title:
Lead Identifier
Read Only:true
The unique identifier of the sales lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextTaskDue: string
(date)
Title:
Next Task Due
Read Only:true
The date when a task is due for a sales lead. -
NumberOfOpenActivities: number
Title:
Total Open Activities
Read Only:true
The total number of activities that are open for the sales lead. -
NumberOfTouches: number
Title:
Total Touches
Read Only:true
The total number of touches in context of the sales lead. A touch refers to an outbound communication such as email sent or phone call made and so on. -
TotalNotes: number
Title:
Total Notes
Read Only:true
The total number of public notes associated with a lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-leadScoreDetails-item-response
Type:
Show Source
object
-
DataType: string
Read Only:
true
Maximum Length:255
The data type associated with the value of the feature used for predictions from the AI models. -
FeatureName: string
Read Only:
true
The name of the feature used for predictions from the AI models. -
FeatureValue: string
Read Only:
true
Maximum Length:255
The value of the feature used for predictions from the AI models. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-MklLeadResources-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
Default Value:FULL
The code indicating the access level of a team member. -
ConflictId: integer
(int64)
Title:
Conflict Identifier
Default Value:1
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this sales lead resource. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this sales lead resource is created. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The e-mail address associated with the sales lead team resource. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the lead sales team resource. -
FunctionalRole: string
Title:
Function
Maximum Length:30
The role played by this Sale team resource for the handling of this sales lead. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the sales lead resource. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales lead resource. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
LeadId: integer
Title:
Lead ID
The unique identifier of the sales lead for this sales lead resource. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate unique identifier of the lead. -
LeadResourceId: integer
Title:
Lead Resource ID
The unique identifier of the sales lead resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager Name
Read Only:true
Maximum Length:360
The name of the sales lead manager. -
Name: string
Title:
Organization
Read Only:true
Maximum Length:240
The name of the sales lead resource. -
PartyName: string
Title:
Team Member
Read Only:true
Maximum Length:360
The name of the party associated with the sales lead resource. -
PartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The contact number of the party associated with the lead resource. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner. -
PrimaryPhonePurpose: string
Title:
Role
Read Only:true
Maximum Length:30
The type of contact point used for updating underlying contact point TCA data. -
ResourceId: integer
Title:
Resource ID
The unique identifier associated with this sales lead resource. -
ResourceOrgId: integer
(int64)
Title:
Resource Organization ID
Read Only:true
The unique identifier of the resource organization associated with this sales lead resource. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:60
The name of the role of the sales lead resource associated with the sales lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-MklLeadTcMembers1-item-response
Type:
Show Source
object
-
AccountName: string
Title:
Existing Account
Read Only:true
Maximum Length:900
The account name associated with lead contacts. -
City: string
Title:
City
Read Only:true
Maximum Length:60
City associated with the identifying address associated with this lead contact. -
ConflictId: integer
Title:
Conflict Identifier
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
ContactDoNotCallFlag: boolean
Title:
Do Not Call
Read Only:true
Maximum Length:1
Indicates if the user can call the person. If the value is True, then the user can not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
ContactDoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates if the user can contact the person by phone, e-mail, or mail. If the value is True, then the user can not contact the person. The default value is False. -
ContactDoNotMailFlag: boolean
Title:
Do Not Mail
Read Only:true
Maximum Length:1
Indicates whether the sales lead person can be contacted. -
ContactJobTitle: string
Title:
Job Title
The label displaying the job title of a contact in his company. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this sales lead contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this sales lead contact is created. -
EmailAddress: string
Title:
Email
The e-mail address associated with the sales lead contact. -
EmailPreference: string
Title:
Email Preference
Read Only:true
Maximum Length:255
Indicates if the lead contact has an email preference of do not email, ok to email, or no value. -
FormattedPhoneNumber: string
Title:
Phone
The formatted phone number of the lead contact. -
JobTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The job title of the sales lead contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the sales lead contact. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales lead contact. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the sales lead record. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the sales lead for this sales lead contact. -
LeadMemberId: integer
(int64)
Title:
Lead Contact ID
The unique identifier for the sales lead contact. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate unique identifier of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgContactId: integer
(int64)
Title:
Organization Contact ID
Read Only:true
The unique identifier of the Organization for this sales lead contact. -
PartyId: integer
(int64)
Title:
Contact Party ID
The unique identifier of the lead to which the contact is associated. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the lead contact. -
PartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The party number of the sales lead contact. -
PartyType: string
Title:
Type
Read Only:true
Maximum Length:30
The type of the party recorded as lead contact. Possible values are person, organization or group. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The party usage recorded for this lead contact in the customer master. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the lead contact. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name or surname of a lead contact. -
PersonTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title associated with the lead contact. This is not the same as the job title. -
PhonePreference: string
Title:
Phone Preference
Read Only:true
Maximum Length:255
Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Postal code part of the identifying address associated with this lead contact. -
PrimaryCustomerId: integer
(int64)
Read Only:
true
The account party identifier of the account associated to the lead contact. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner. -
RelationshipId: integer
(int64)
Title:
Relationship ID
The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer. -
Role: string
Title:
Function
Maximum Length:30
The role of lead contact in the context of this lead. -
State: string
Title:
State
Read Only:true
Maximum Length:60
State part of the identifying address associated with this lead contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-MklLeadTeam-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Read Only:true
Maximum Length:30
Default Value:FULL
The access level granted to the lead team member, manager, and administrator of the organizations in the resource hierarchy. -
AddedOnDateTime: string
(date-time)
Title:
Join Date
The create date and time for the lead team member based either on the date the resource was added to the lead resource or the date the territory was added to lead territory. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city of the resource. -
ConflictId: integer
(int64)
Read Only:
true
Default Value:1
The conflict identifier. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The country code of the resource. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user identifier of the user who created the lead team member. -
CreationDate: string
(date-time)
Read Only:
true
The create date and time of the lead team member. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the resource. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The formatted phone number of the resource. -
FunctionalRole: string
Title:
Function
Read Only:true
Maximum Length:30
The code of the function or role of the lead team member. -
FunctionCode: string
Title:
Function
Read Only:true
Maximum Length:30
The code of the function or role of the lead team member. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the lead team was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the lead team. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the lead team. -
LeadId: integer
(int64)
The unique identifier of the lead.
-
LeadNumber: string
Title:
Lead Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the lead. -
LeadResourceId: integer
Read Only:
true
The unique identifier of the lead resource. -
LeadTeamId: integer
(int64)
The unique identifier of the lead team.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerFlag: boolean
Read Only:
true
Indicates whether the lead team member is the owner of the lead. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the resource. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate identifier of the resource. -
PrimaryFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Indicates whether the lead team member is the owner of the lead. -
PrimaryPhoneNumber: string
Read Only:
true
Maximum Length:40
Primary formatted phone number for the resource. -
PrimaryPhonePurpose: string
Title:
Role
Read Only:true
Maximum Length:30
Primary purpose of the phone for the resource. -
ResourceId: integer
(int64)
Resource party identifier of the lead team member.
-
ResourceRoleName: string
Read Only:
true
Maximum Length:255
The role name of the resource. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state of the resource. -
TerritoryFunctionCode: string
Title:
Territory Function
Read Only:true
Maximum Length:30
The code of the business function of the territory. -
TerritoryName: string
Title:
Territory Name
Read Only:true
Maximum Length:60
The name of the territory. -
TerritoryNumber: string
Title:
Number
Read Only:true
Maximum Length:30
The number of the territory. -
TerritoryOwnerFlag: boolean
Read Only:
true
Indicates whether the lead team member is the territory owner. -
TerritoryVersionId: number
Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.
-
TypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
Default Value:PRIME
The code of the type of the territory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-MklLeadTerritoryAssoc-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Title:
Conflict Identifier
Default Value:1
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the lead territory record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the lead territory record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead label. -
LeadTerritoryId: integer
(int64)
Title:
Lead Territory Identifier
The unique identifier of the territory for a sales lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Territory
Read Only:true
Maximum Length:60
The name of the territory the lead is assigned to. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The alternate owner number key for referenced owner. -
PartnerPartyId: integer
(int64)
Title:
Partner Identifier
Read Only:true
The unique identifier of the partner associated with the territory. -
PartnerPartyName: string
Title:
Partner Name
Read Only:true
Maximum Length:360
The name of the partner associated with the territory. -
PartyId: integer
(int64)
Title:
Owner Party Identifier
Read Only:true
The party identifier of the territory owner. -
PartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The primary person responsible for working on the lead. -
TerritoryId: integer
Title:
Territory Identifier
The unique identifier of the territory for a sales lead. -
TerritoryNumber: string
Title:
Territory Number
Read Only:true
Maximum Length:30
The unique alternate identification number for the territory associated with the lead. -
TerritoryVersionId: integer
(int64)
Title:
Territory Version Identifier
Default Value:1
The unique identifier of the territory version. -
TypeCode: string
Title:
Type
Read Only:true
Maximum Length:30
The type of the territory associated with the lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-MklProdAssoc1-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount associated with the sales lead product. -
AverageTimeToClose: number
Title:
Average Time to Close
The average time to close for this sales lead product. -
ConflictId: integer
Title:
Conflict Identifier
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this sales lead product. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this sales lead product is created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Description: string
Title:
Item Description
Maximum Length:240
The product description where the product is associated with the lead. -
EstimatedUnitPrice: number
Title:
Estimated Unit Price
The estimated unit price for this lead product. -
InventoryItemId: integer
(int64)
Title:
Inventory Number
The unique inventory item identifier associated with the lead product. -
ItemNumber: string
Title:
Inventory Item Number
Read Only:true
Maximum Length:300
The alternate key for referenced inventory item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the sales lead product. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales lead product. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the sales lead for this sales lead product. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate unique identifier of the lead. -
LeadProductId: integer
(int64)
Title:
Lead Product ID
The unique identifier of the current sales lead product. -
LeadProductNumber: string
Title:
Lead Product Number
Maximum Length:30
The alternate key of the lead product. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
A detailed description of the sales lead product. -
OrganizationId: integer
(int64)
Title:
Organization
The unique inventory organization identifier associated with this lead product. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether this product is a primary product for this lead. -
ProductGroupDescription: string
Title:
Product Group Description
Read Only:true
Maximum Length:1000
A brief description of the product group. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductGroupName: string
Title:
Product Group Name
Maximum Length:250
The name of the product group associated with the sales lead product resource. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The alternate key for referenced product group. -
ProductType: string
Title:
Product Type
The type of the product, such as item or product group. -
Quantity: number
Title:
Quantity
The product quantity identified for this product on the lead. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure associated with this sales lead product line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship populated when the note is associated with a sales lead contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the sales lead. 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 of 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 and time 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 associated with the lead. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
The system generated user key. It can come from external system also. -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
NoteTxt: string
(byte)
Title:
Note
The column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type of the note. A list of valid values defined in the lookup NoteSourceTypeVA. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The identifier for the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the lead associated with the note. Either the PartyId, PartyNumber, or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the lead record with which the lead is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of a lead party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the type of the source object such as Activities, Opportunities, 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 : leads-OrchestrationAssociations-item-response
Type:
Show Source
object
-
ActionParameters: string
Title:
Action Parameters
Maximum Length:1000
List of parameters required to execute the action specified through PERFORM_ACTION field. -
AssociationStatusCode: string
Title:
Association Status Code
Maximum Length:30
The status of the association. -
CompletedObjsCnt: integer
Title:
Completed Objectives Count
Read Only:true
The count of completed objectives. -
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 when the record was created. -
CurrentAssocFlag: boolean
Title:
Current Association
Read Only:true
Maximum Length:1
Indicates whether it's the current ACTIVE association or the most recently updated association. -
ErrorLogs: array
Error Logs
Title:
Error Logs
The error logs resource is used to view error logs associated to the orchestration associations. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextStepId: integer
(int64)
Title:
Next Step ID
Read Only:true
The unique identifier of the next step to be executed as part of the current Orchestration. -
NextStepSmartActionId: integer
(int64)
Title:
Next Step Smart Action ID
Read Only:true
The smart action identifier of the next step to be executed as part of the current Orchestration. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The alternate identifier of the orchestration association. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Maximum Length:64
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
PendingObjectivesCount: integer
Title:
Pending Objectives Count
Read Only:true
Number of pending objectives. -
PerformAction: string
Title:
Action to Perform
Maximum Length:30
The action that user can perform on this orchestration association. -
SkippedNothelpfulObjsCnt: integer
Title:
Skipped Objectives Count
Read Only:true
The count of skipped or not helpful objectives. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent object code. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object code. -
StageObjectives: array
Stage Objectives
Title:
Stage Objectives
The stage objectives resource is used to view the stage objectives of the orchestration association. -
Stages: array
Stages
Title:
Stages
The stages resource is used to view the stage of the orchestration association. -
Steps: array
Steps
Title:
Steps
The steps resource is used to view the steps of the orchestration association. -
StepsInExecutionPath: array
Steps In Execution Path
Title:
Steps In Execution Path
The steps in execution path resource is used to view all the steps including future steps of the orchestration association. -
StepTransitions: array
Step Transitions
Title:
Step Transitions
The step transitions resource is used to view the step transitions of the orchestration association. -
TotalObjsCnt: integer
Title:
Total Objectives Count
Read Only:true
The total number of objectives.
Nested Schema : Error Logs
Type:
array
Title:
Error Logs
The error logs resource is used to view error logs associated to the orchestration associations.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Stage Objectives
Type:
array
Title:
Stage Objectives
The stage objectives resource is used to view the stage objectives of the orchestration association.
Show Source
Nested Schema : Stages
Type:
array
Title:
Stages
The stages resource is used to view the stage of the orchestration association.
Show Source
Nested Schema : Steps
Type:
array
Title:
Steps
The steps resource is used to view the steps of the orchestration association.
Show Source
Nested Schema : Steps In Execution Path
Type:
array
Title:
Steps In Execution Path
The steps in execution path resource is used to view all the steps including future steps of the orchestration association.
Show Source
Nested Schema : Step Transitions
Type:
array
Title:
Step Transitions
The step transitions resource is used to view the step transitions of the orchestration association.
Show Source
Nested Schema : leads-OrchestrationAssociations-ErrorLogs-item-response
Type:
Show Source
object
-
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 when the record was created. -
ErrorDescription: string
(byte)
Title:
Error Description
The description of the error. -
ErrorLogsId: integer
(int64)
Title:
Error Logs ID
The unique identifier of the orchestration error logs. -
ErrorLogsNumber: string
Title:
Error Logs Number
Maximum Length:64
The alternate identifier of the orchestration error logs. -
ErrorText: string
Title:
Error Text
Maximum Length:2000
The brief error details. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent object code. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-OrchestrationAssociations-StageObjectives-item-response
Type:
Show Source
object
-
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 when the record was created. -
DisplaySequence: integer
Title:
Display Sequence
The order in which the Stages to be executed or displayed in the User Interface. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the stages in the orchestration admin run time UIs. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageObjDescription: string
Title:
Objective Description
Read Only:true
Maximum Length:2000
The description text of the orchestration stage objective object. -
OrchestrationStageObjDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the stages in the orchestration admin run time UIs. -
OrchestrationStageObjectiveId: integer
(int64)
Title:
Stage Objective ID
The unique identifier of the orchestration stage objective object. -
OrchestrationStageObjName: string
Title:
Objective Name
Read Only:true
Maximum Length:100
The name of the orchestration stage objective object. -
OrchestrationStageObjNumber: string
Title:
Stage Objective Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage objective object. -
RunTimeStageObjectiveId: integer
(int64)
Title:
Run Time Stage Objective ID
The unique identifier of the orchestration stage objective object. -
RunTimeStageObjectiveNumber: string
Title:
Run Time Stage Objective Number
Maximum Length:64
The alternate identifier of the orchestration stage objective object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The status of the orchestration stage objective transition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-OrchestrationAssociations-Stages-item-response
Type:
Show Source
object
-
CompletedObjsCnt: integer
Title:
Completed Objectives Count
The count of completed objectives. -
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 when the record was created. -
CurrentStageFlag: boolean
Title:
Current Stage
Maximum Length:1
Indicates whether it's the current INPROGRESS stage or the most recently updated stage. -
DisplaySequence: integer
Title:
Display Sequence
Order in which the Stages to be executed/shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageDescription: string
Title:
Objective Description
Read Only:true
Maximum Length:2000
The description text of the orchestration stage object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
PendingObjectivesCount: integer
Title:
Pending Objectives Count
Number of pending objectives. -
RuntimeStageId: integer
(int64)
Title:
Run Time Stage ID
The unique identifier of the orchestration stages runtime object. -
RuntimeStageNumber: string
Title:
Run Time Stage Number
Maximum Length:64
The alternate identifier of the orchestration stages runtime object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The status of the orchestration stages. -
SkippedNothelpfulObjsCnt: integer
Title:
Skipped Objectives Count
The count of skipped or not helpful objectives. -
StageEndDate: string
(date-time)
Title:
Stage End Date
The date and time when the stage execution starts. -
StageStartDate: string
(date-time)
Title:
Stage Start Date
The date and time when the stage execution ends. -
StepsCountInExecutionPath: integer
Title:
Step Count in Execution Path
Read Only:true
Number of Steps in the execution path for the orchestration stage. -
TotalObjsCnt: integer
Title:
Total Objectives Count
The total number of objectives.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-OrchestrationAssociations-Steps-item-response
Type:
Show Source
object
-
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 when the record was created. -
CurrentStepFlag: boolean
Title:
Current Step
Maximum Length:1
Indicates whether it's the current INPROGRESS step or the most recently updated step. -
DisplaySequence: integer
Title:
Display Sequence
Order in which the Stages to be executed/shown back in UI. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
RunTimeStatus: string
Title:
Run Time Status
Maximum Length:30
The run time status of the orchestration stage objective transition. -
RunTimeStepId: integer
(int64)
Title:
Run Time Step ID
The unique identifier of the orchestration steps runtime object. -
RunTimeStepNumber: string
Title:
Run Time Step Number
Maximum Length:64
The alternate identifier of the orchestration steps runtime object. -
StepEndDate: string
(date-time)
Title:
Step End Date
The date and time when the step execution ends. -
StepStartDate: string
(date-time)
Title:
Step Start Date
The date and time when the step execution starts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-OrchestrationAssociations-StepsInExecutionPath-item-response
Type:
Show Source
object
-
ContainMultipleTasks: string
Read Only:
true
Maximum Length:1
Indicates whether the step contains multiple tasks. -
CurrentStepFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether it's the current INPROGRESS step or the most recently updated step. -
DisplaySequence: integer
(int32)
Read Only:
true
The order of the steps in the orchestration administrator runtime UIs. -
ExecutionMethod: string
Read Only:
true
Maximum Length:30
The execution type for the orchestration step. The possible values are Manual and Automatic. -
FulfillsObjectiveCnt: integer
Read Only:
true
The count of objectives. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssocId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration association. -
OrchestrationStageId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration stage object. -
OrchestrationStageObjId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration stage objective object. -
OrchestrationStepId: integer
(int64)
Read Only:
true
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Read Only:
true
Maximum Length:100
The name of orchestration step. -
RunTimeStatus: string
Read Only:
true
Maximum Length:30
The runtime status of the orchestration steps. -
StepEndDate: string
(date-time)
Read Only:
true
Specifies the date and time when the step execution ends. -
StepStartDate: string
(date-time)
Read Only:
true
Specifies the date and time when the step execution starts. -
StepSuggestionText: string
Read Only:
true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepType: string
Read Only:
true
Maximum Length:30
The type of step.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-OrchestrationAssociations-StepTransitions-item-response
Type:
Show Source
object
-
ActivityAppointmentStatusCode: string
Title:
Appointment Status
Read Only:true
Maximum Length:30
Denotes the status of the Appointment. -
ActivityDescription: string
(byte)
Title:
Description
Read Only:true
A text field for capturing some descriptive information about the activity. -
ActivityDueDate: string
(date)
Title:
Due Date
Read Only:true
The date the task activity is due to be completed. -
ActivityEndDate: string
(date-time)
Title:
End Date
Read Only:true
The end date and time of an appointment, or the completion time of a task. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity. -
ActivityNumber: string
Title:
Activity Number
Read Only:true
Maximum Length:64
Alternate identifier of the activity. System generated or can come from external system (user key). -
ActivityOwnerId: integer
(int64)
Title:
Owner ID
Read Only:true
The primary resource on the activity. Supports resources only. -
ActivityOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
Name of the party. -
ActivityPartialDescription: string
Title:
Short Description
Read Only:true
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivitySMARTActionContext: string
Title:
Smart Action Context
Read Only:true
Maximum Length:4000
Stores metadata needed for smart action -
ActivitySMARTActionId: integer
(int64)
Title:
Smart Action ID
Read Only:true
Smart action identifier. Foriegn key from zca_user_action. -
ActivityStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation datetime for a task. -
ActivitySubject: string
Title:
Subject
Read Only:true
Maximum Length:500
Subject or name ot title of the activity. -
ActivityTaskStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Status of the activity. Defaulted to NOT_STARTED. -
ActivityWebConferenceId: string
Title:
Web Conference ID
Read Only:true
Maximum Length:255
The unique identifier of the web conference. -
ActivityWebConferenceURL: string
Title:
Web Conference URL
Read Only:true
Maximum Length:2000
The web conference join URL. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Read Only:true
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in guidance primary or secondary banner. -
Comments: string
Title:
Comments
Maximum Length:2000
Specifies the brief comments required for runtime step transition row. -
ConversationId: integer
(int64)
Title:
Conversation ID
The unique identifier of conversation message. -
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 when the record was created. -
EmailType: string
Title:
Email Type
Maximum Length:30
The type of the email to which the step transitions is associated with. -
ExitOrchestrationFlag: boolean
Title:
Exit Orchestration
Read Only:true
Maximum Length:1
Indicates whether or not to exit the orchestration when stop step occurs. -
InboundConvMsgId: integer
(int64)
Title:
Inbound Conversation Message ID
The unique identifier of inbound conversation message. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration step object. -
OrchestrationStepTasksId: integer
(int64)
Title:
Orchestration Step Tasks ID
Unique identifier for the orchestration step tasks. -
OrchestrationStepType: string
Title:
Step Type
Read Only:true
Maximum Length:30
The type of step. -
OrchStepTransitionFlag: boolean
Title:
Current Step Transition
Maximum Length:1
Indicates whether it's the current INPROGRESS Step transition or the most recently updated step transition row. -
OutboundConvMsgId: integer
(int64)
Title:
Outbound Conversation Message ID
The unique identifier of outbound conversation message. -
RefreshPageFlag: boolean
Title:
Refresh Page
Maximum Length:1
Indicates whether or not to refresh the whole page before surfacing the current step in the runtime UI. -
StepDisplaySequence: integer
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepSuggestionText: string
Title:
Step Suggestion Text
Read Only:true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepTaskDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepTransitionId: integer
(int64)
Title:
Step Transition ID
The alternate identifier of the orchestration step transition object. -
StepTransitionNumber: string
Title:
Step Transition Number
Maximum Length:64
The unique identifier of the orchestration step transition object. -
StepType: string
Title:
Step Type
Maximum Length:30
The type of step. -
SuccessCriteriaEvalFlag: boolean
Title:
Success Criteria Evaluation Flag
Maximum Length:1
Specifies the success criteria evaluation result for the step. -
TransitionDueDateTime: string
(date-time)
Title:
Transition Due Date Time
The date and time when the step transition is due. -
TransitionEndDateTime: string
(date-time)
Title:
Transition End Date Time
The date and time when the step transition ended. -
TransitionStartDateTime: string
(date-time)
Title:
Transition Start Date Time
The date and time when the step transition started. -
TransitionStatus: string
Title:
Transition Status
Maximum Length:30
The status of the orchestration step transition. -
WrapUpId: integer
(int64)
Title:
Wrap-up ID
The unique identifier of the wrap up.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-productGroups-item-response
Type:
Show Source
object
-
Description: string
Title:
Description
Read Only:true
Maximum Length:1000
A brief description of the product group. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the product group. -
LastUpdateDate: string
Title:
Last Updated Date
Read Only:true
The date the product group was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Read Only:
true
The model configuration attributes associated with the product group. -
ModelName: string
Read Only:
true
The model name associated with the product group. -
ProdGroupId: integer
Title:
Product Group ID
Read Only:true
The unique identifier of the product group. -
QuotableFlag: boolean
Title:
Quotable
Read Only:true
Indicates whether a product group is quotable. -
ReferenceNumber: string
Title:
Reference Number
Read Only:true
The reference number of the product group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-products-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Read Only:true
Indicates if the Product is active. If the value is True, then the Product is active. The default value is True. -
CSSEnabled: string
Read Only:
true
Indicates whether the product is enabled for Customer Self Service (CSS) or not. Only products that are enabled for CSS can be viewed using the customer self service portal. -
Description: string
Title:
Name
Read Only:true
Maximum Length:255
A brief description of the product. -
EndDate: string
(date-time)
Title:
Effective to Date
Read Only:true
The date after which the Product is inactive. -
InventoryItemId: integer
Title:
Inventory Item ID
Read Only:true
The unique identifier of the Inventory Item. -
InvOrgId: integer
Title:
Inventory Organization ID
Read Only:true
The unique identifier of the Inventory Organization. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the product was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Description
Read Only:true
Maximum Length:4000
A detailed description of the product. -
ProdGroupId: integer
Title:
Product Group ID
Read Only:true
The unique identifier of the Product Group. -
ProductNum: string
Title:
Product Number
Read Only:true
The number of the product. -
ProductType: string
Title:
Product Type
Read Only:true
The type of the product, such as item or product group. -
ServiceRequestEnabledCode: string
Read Only:
true
The code indicating if service requests are enabled for the associated product. -
StartDate: string
(date-time)
Title:
Effective from Date
Read Only:true
The date from which the Product is active. -
Text: string
Title:
Keyword
The text or keywords associated with the product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-SalesContents-item-response
Type:
Show Source
object
-
CanDelete: string
Read Only:
true
Default Value:Y
Indicates whether user can delete the content item or not. -
CanUpdate: string
Read Only:
true
Default Value:Y
Indicates whether user can update the content item or not. -
ContentItemId: string
Title:
Content ID
Maximum Length:64
The internal content item identifier from the source system. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the sales content item. -
ContentItemType: string
Read Only:
true
Indicates the type of content, for example pdf, png, and so on. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
Indicates from where the content item is sourced. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether the referred sales content item is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Indicates the sequence in which the sales content should appear in a page. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentObjectId: integer
(int64)
Title:
Parent Object ID
The unique identifier of the object associated to the sales content row. -
ParentObjectType: string
Maximum Length:
128
The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public content item identifier from the source system. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The name of the public sales content item. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The name of the customer for which the public content was published. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The date on which the public content item was published. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The link of the public content item. -
SalesContentId: integer
(int64)
Title:
Sales Content ID
Read Only:true
The unique identifier of the sales content.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : leads-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
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. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates whether the action can be mass processed. -
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 associated with the 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 the 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 : leads-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:1000
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 : leads-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 : leads-sourceCodes-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates an active or inactive status of this source code. -
CampaignId: integer
Title:
Campaign ID
The unique identifier of the campaign associated with this source code. -
CampaignName: string
Title:
Campaign
Read Only:true
Maximum Length:250
The name of the campaign associated with this source code. -
CampaignUsage: string
Title:
Campaign Type
Read Only:true
Maximum Length:30
Campaign Usage associated with source code. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this source code record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this record is created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
Who column: indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
SourceCode: string
Title:
Source Code
Maximum Length:100
The source code that represents this record. -
SourceCodeId: integer
(int64)
Title:
Source Code ID
The unique identifier of the source code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- acceptLead
-
This method lets you accept a lead.
- convertLeadToOpty
-
Converts the passed lead identifier to an opportunity.
- rankLead
-
This method lets you update the rank value on the lead.
- rejectLead
-
This method lets you set the lead assignment status to Rejected.
- runAssignment
-
Runs the assignment for the passed lead identifier and assigns either resources or territories to the lead.
- scoreLead
-
This method lets you score the lead based on rules.
Examples
The following example shows how to get all sales leads by submitting a GET request on the REST resource using cURL.
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/
Example of Response Body
The following example shows the contents of the response body in JSON format.:
{ "items": [ { "Name": "LEAD 1", "LeadNumber": "LEAD 1", "OwnerPartyName": null, "StatusCode": "UNQUALIFIED", "Rank": "HOT", ....... "links": [ ..... ] }, { "Name": "LEAD 2", "LeadNumber": "LEAD 2", "OwnerPartyName": null, "StatusCode": "UNQUALIFIED", "Rank": "HOT", ....... "links": [ ........ ] } ..... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads", "name": "leads", "kind": "collection" } ] }