Oracle CRM On Demand Documentation Library: Lead

Oracle Web Services On Demand Guide > Oracle CRM On Demand Objects Accessible Through Web Services > Core Parent Objects (Web Services v1.0) >

Lead

The lead object stores information on a company or individual with whom an opportunity can be created. It allows the user to identify the companies that might be interested in a product or service. Leads are usually generated as part of a marketing campaign.

Parent Objects

Account, Campaign, Contact, Opportunity, Team

Child Components

Activity, Attachment, Book, Campaign.

For information about using attachments with this object, see Using Attachments with Web Services On Demand.

Methods Called

Table 236 details the methods called by the Lead service.

Table 236. Methods Called by Lead Service
Method	Name as Defined in Service
Delete	LeadDelete
DeleteChild	LeadDeleteChild
Insert	LeadInsert
InsertChild	LeadInsertChild
InsertOrUpdate	LeadInsertOrUpdate
QueryPage	LeadQueryPage
Update	LeadUpdate
UpdateChild	LeadUpdateChild

Fields

Table 237 details the required and read-only fields for the lead object.

Table 237. Required and Read-Only Fields for the Lead Object
Child Component	Field Name	Type
Lead (parent)	FirstName	Required
	LastName	Required
	LeadOwner	Required
	ContactFullName	Read-only
	Audit Fields	Read-only
	LastUpdated	Read-only
	LeadConcatField	Read-only
	LeadFullName	Read-only
	ReferredById	Read-only
Activity	AccountLocation	Read-only
	CreatedDetail	Read-only
	Lead	Read-only
	LeadExternalId	Read-only
	MEEventName	Read-only
	CreatedbyEmailAddress	Read-only
	ModifiedbyEmailAddress	Read-only
	CODInteractionTime	Read-only
	CODWrapUpTime	Read-only
	CODHandleTime	Read-only
	CODIVRTime	Read-only
	CODQueueHoldTime	Read-only
	CODTotalHoldTime	Read-only
	DescriptionShadow	Read-only
	Duration	Read-only
	Audit Fields	Read-only
Attachment	DisplayFileName	Required
	FileNameOrURL	Required
	FileDate	Read-only
	FileSize	Read-only
	LeadId	Read-only
	Id	Read-only
	ModId	Read-only
	Audit Fields	Read-only
Book	BookName	Required
	BookId	Read-only
	SystemAssociateFlag	Read-only
	ModId	Read-only
	Audit Fields	Read-only

Table 238 details the status key for the lead object.

Table 238. Status Key for the Lead Object
Child Component	Field Name
Lead (parent)	Audit Fields
	AccountId
	CampaignId
	ContactId
	ExternalSystemId
	Id
	IntegrationId
	LastUpdated
	OpportunityId
Activity	Audit Fields
	ExternalSystemId
	Id
	IntegrationId
	LeadId
Attachment	Audit Fields
	Id
	LeadId
Book	Audit Fields
	BookId
	ModId

Table 239 details the pick map fields for the lead object.

Table 239. Pick Map Fields for the Lead Object
Child Component	Pick Map Field	Maps To
Lead (parent)	Campaign	CampaignId
	OpportunityName	OpportunityId
	Owner	OwnerId
	AccountExternalSystemId	AccountId
	OpportunityExternalSystemId	OpportunityId
	ContactExternalSystemId	ContactId
	CampaignExternalSystemId	CampaignId
	ReferredByExternalSystemId	ReferredById
Activity	AccountIntegrationId	AccountId
	AccountExternalId	AccountId
	Address	AddressId
	AssignedTo	AssignedToId
	CampaignExternalId	CampaignId
	CampaignIntegrationId	CampaignId
	DelegatedBy	DelegatedById
	Dealer	DealerId
	FundRequest	FundRequestId
	OpportunityIntegrationId	OpportunityId
	OpportunityExternalId	OpportunityId
	PrimaryContactIntegrationId	PrimaryContactId
	PrimaryContactExternalId	PrimaryContactId
	LeadIntegrationId	LeadId
	LeadExternalId	LeadId
	OwnerExternalId	OwnerId
	OwnerIntegrationId	OwnerId
	SRIntegrationId	SRId
	SRExternalId	SRId
	CustomObject1Name	CustomObject1Id
	CustomObject2Name	CustomObject2Id
	CustomObject3Name	CustomObject3Id
Book	BookName	BookId

Table 240. Filterable Fields and User Key Fields on the Lead Object's Child Components
Child Components	Filterable Fields	User Key Field Combinations
Lead (parent)	All	LeadId
		IntegrationId
		ExternalSystemId
		LeadFirstName and LeadLastName
		Description
Activity	Type	Type and Description
	Owner	IntegrationId
	Subject	ExternalSystemId
	DueDate
	Priority
	Status
Attachment	None	Id
		ExternalSystemId
		FileNameOrURL and FileExtension
Book	None	BookId
Book	None	BookName
Partner	None	PartnerIntegrationId
		PartnerExternalSystemId

Table 241 details the picklists available for the lead object.

Table 241. Picklists Available for the Lead Object
Field Name
AssessmentCategory1 through AssessmentCategory4
Country
IndexedPick0 through IndexedPick5
LeadType
MrMrs
OwnershipStatus
Rating
Source
StateProvince
Status

For more information on the fields accessible through the Lead Web service, go to the Web Services Administration page within the Oracle CRM On Demand application and generate the WSDL file for the lead object.

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37)		Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.