Jump to

• Request
• Response
• Examples

Update a sales lead

patch

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}

Request

Path Parameters

• leadsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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).
• 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.
• 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.
• 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.
• 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.
• 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.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of a sales lead.
• 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.
• IBAssetId: integer (int64)
  Title: Installed Base Asset

  The unique identifier 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "RejectByUserId":{
            "title":"Reject by User ID",
            "type":"integer",
            "description":"The unique identifier of the sales representative who rejected this sales lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RetiredDateTime":{
            "title":"Retired Time Stamp",
            "type":"string",
            "description":"The date and time when the sales lead is moved to a retired status.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "EligibleForConversionFlag":{
            "title":"Eligible for Conversion",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies whether the lead is eligible for conversion to opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group if this record represents a product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactProvince":{
            "title":"Primary Contact Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province where the primary contact of the lead is located.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"15"
            }
        },
        "PrimaryContactPostalCode":{
            "title":"Primary Contact Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The zip code where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealAmount":{
            "title":"Deal Size",
            "type":"number",
            "description":"The total amount attributed to a lead.",
            "nullable":true
        },
        "PrimaryContactPhonePreference":{
            "title":"Phone Preference",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"The unique identifier for the IB asset associated with the sales lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The Email address for the primary sales lead contact on the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "PrimaryPhoneVerificationDate":{
            "title":"Primary Phone Verification Date",
            "type":"string",
            "description":"The verification date for lead primary phone.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactEmailPreference":{
            "title":"Email Preference",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesContents":{
            "title":"Sales Contents",
            "type":"array",
            "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-SalesContents-item-patch-request"
            }
        },
        "PrimaryProductGroupId":{
            "title":"Primary Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the primary product group associated with a lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ConvertedDateTime":{
            "title":"Converted Date",
            "type":"string",
            "description":"The date and time when the sales lead is converted to an opportunity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryPhoneAreaCode":{
            "title":"Primary Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The primary phone area code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "PartnerProgramId":{
            "title":"Partner Program",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the primary product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the Customer. It is a reference to the customer record in the TCA schema.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            }
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the lead address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "Project":{
            "title":"Customer Project",
            "maxLength":"30",
            "type":"string",
            "description":"The customer project identified for this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "QualifiedDate":{
            "title":"Qualification Date",
            "type":"string",
            "description":"The date when this sales lead was qualified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "QualifiedDateTime"
                ]
            }
        },
        "OrganizationSize":{
            "title":"Organization Size",
            "maxLength":"30",
            "type":"string",
            "description":"The size of the Organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesTargetLeadEloquaSyncDate":{
            "title":"Last Sync to Marketing Date",
            "type":"string",
            "description":"The date on which the current sales target lead contacts are last synced to Eloqua.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastAssignmentDate":{
            "title":"Last Automatic Assignment Date",
            "type":"string",
            "description":"The date on which the lead was last reassigned.",
            "format":"date-time",
            "nullable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Contact Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The primary phone number for the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to capture comments, information, or instructions for a sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-Note-item-patch-request"
            }
        },
        "PrimaryProductGroupReferenceNumber":{
            "title":"Primary Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate key for the referenced primary product group.",
            "nullable":false
        },
        "productGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-productGroups-item-patch-request"
            }
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the asset associated with the sales lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber"
                ]
            }
        },
        "LeadRollup":{
            "title":"Lead Rollups",
            "type":"array",
            "description":"The lead rollups resource is used to view a sales lead rollup.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadRollup-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "Building":{
            "title":"Building",
            "maxLength":"40",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesTargetLeadValidationDueDate":{
            "title":"Validation Due Date",
            "type":"string",
            "description":"The date on which the sales target lead validation is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SourceCode":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The marketing source code associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignNameLOV"
                ]
            }
        },
        "FloorNumber":{
            "title":"Contact Address Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead contact marked as a primary lead contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of a sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadCompetitors":{
            "title":"Sales Lead Competitors",
            "type":"array",
            "description":"The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadCompetitors-item-patch-request"
            }
        },
        "PrimaryContactMailPreference":{
            "title":"Mail Preference",
            "maxLength":"30",
            "type":"string",
            "description":"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. \nA 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.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactState":{
            "title":"Primary Contact State",
            "maxLength":"60",
            "type":"string",
            "description":"The state where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the sales lead contact.",
            "nullable":true
        },
        "WorkPhoneAreaCode":{
            "title":"Work Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The area code of the work phone associated with the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The product resource is used to capture the name of the product associated with the sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-products-item-patch-request"
            }
        },
        "BudgetStatus":{
            "title":"Budget Status",
            "maxLength":"120",
            "type":"string",
            "description":"The budget status associated with the Budget Amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "SalesTargetLeadOptOutReasonCode":{
            "title":"Opt-out Reason",
            "maxLength":"32",
            "type":"string",
            "description":"The reason for opting out the lead from sales target campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "InventoryItemDescription":{
            "title":"Product Item",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the product added to a lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique party identifier associated with the owner of this sales lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            }
        },
        "RetireReasonCode":{
            "title":"Retire Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for retiring the lead. A list of valid values is defined in the lookup RetireReasonVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "RetireComment":{
            "title":"Retirement Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The comments recorded when the sales lead is moved to a retired status.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLinesPhonetic":{
            "title":"Contact Phonetic Address",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign of the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            }
        },
        "leadScoreDetails":{
            "title":"Lead Score Details",
            "type":"array",
            "description":"The lead score details resource is used to view the details of lead conversion probability.",
            "items":{
                "$ref":"#/components/schemas/leads-leadScoreDetails-item-patch-request"
            }
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.",
            "nullable":true
        },
        "ApprovalDateTime":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"The date and time when the sales lead is approved. This is only applicable to deal registrations.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LeadLastUpdatedBy":{
            "title":"Lead Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"campaigns"
            }
        },
        "Interviews":{
            "title":"Interviews",
            "type":"array",
            "description":"The interviews resource is used to view and delete an interview record.",
            "items":{
                "$ref":"#/components/schemas/leads-Interviews-item-patch-request"
            }
        },
        "MklLeadTeam":{
            "title":"Lead Team",
            "type":"array",
            "description":"The lead teams resource is used to view the team members and territory team members associated with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTeam-item-patch-request"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"120",
            "type":"string",
            "description":"The approval Status of the sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Rank":{
            "title":"Rank",
            "maxLength":"30",
            "type":"string",
            "description":"The rank associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "MklLeadTerritoryAssoc":{
            "title":"Sales Lead Territories",
            "type":"array",
            "description":"The sales lead territories resource is used to view the associated sales lead territories.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTerritoryAssoc-item-patch-request"
            }
        },
        "PrimaryPhoneVerificationStatus":{
            "title":"Primary Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for lead primary phone.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityOwnerNumber":{
            "title":"Opportunity Owner Number",
            "type":"string",
            "description":"The alternate identifier for the owner of the opportunity created from converting the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for rejecting the lead. A list of valid values is defined in the lookup RejectReasonVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "PrimaryPhoneCountryCode":{
            "title":"Primary Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The primary phone country code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when a sales lead will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ToReassignFlag":{
            "title":"Reassign",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates leads that are either unassigned or have been selected for automatic reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "LeadCampaigns":{
            "title":"Lead Campaigns",
            "type":"array",
            "description":"The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadCampaigns-item-patch-request"
            }
        },
        "PrimaryContactPersonFirstName":{
            "title":"Primary Contact First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "ReassignReasonCode":{
            "title":"Reassign Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for reassigning the lead. A list of valid values is defined in the lookup ReassignVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "ChannelType":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"The channel through which a lead contacted the company.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "PartnerType":{
            "title":"Partner Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the primary partner associated with this sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartnerId"
                ]
            }
        },
        "PrimaryContactCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PrimaryContactCountryName"
                ]
            }
        },
        "PrimaryContactPersonMiddleName":{
            "title":"Primary Contact Middle Name",
            "maxLength":"150",
            "type":"string",
            "description":"The middle name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "PrimaryCompetitorName":{
            "title":"Primary Competitor",
            "type":"string",
            "description":"The name of the primary competitor of the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCompetitorName1"
                ]
            }
        },
        "PartnerId":{
            "title":"Primary Partner Identifier",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            }
        },
        "LeadLastUpdateDate":{
            "title":"Lead Last Update Date",
            "type":"string",
            "description":"The date when the lead record was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "ContactTimezoneCd":{
            "title":"Contact Time Zone",
            "maxLength":"35",
            "type":"string",
            "description":"The preferred time zone of the contact pursued on the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the lead address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary campaign of the lead.",
            "nullable":false
        },
        "PrimaryContactCounty":{
            "title":"Primary Contact County",
            "maxLength":"60",
            "type":"string",
            "description":"The county where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicates the current status of the lead. A list of valid values is defined in the lookup StatusCodeVA.",
            "nullable":true,
            "default":"UNQUALIFIED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the sales lead.",
            "nullable":true
        },
        "Name":{
            "title":"Lead Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the lead.",
            "nullable":false
        },
        "OrchestrationAssociations":{
            "title":"Orchestration Associations",
            "type":"array",
            "description":"The orchestrations associations resource is used to view, create, update, and delete an orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-item-patch-request"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-item-patch-request"
            }
        },
        "LeadAcceptedFlag":{
            "title":"Accepted",
            "maxLength":"4",
            "type":"boolean",
            "description":"Indicates if the lead has been accepted.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableCreateAccount":{
            "title":"Create Account",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new account should be created during lead conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ClassCode4":{
            "title":"Auxiliary Classification Code 3",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ClassCode3":{
            "title":"Auxiliary Classification Code 2",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The verification date for primary contact email address.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "MklProdAssoc1":{
            "title":"Sales Lead Products",
            "type":"array",
            "description":"The sales lead products resource is used to capture a product associated with the sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-MklProdAssoc1-item-patch-request"
            }
        },
        "ClassCode2":{
            "title":"Auxiliary Classification Code 1",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ClassCode1":{
            "title":"Industry Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailVerificationStatus":{
            "title":"Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for primary contact email address.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactPersonLastName":{
            "title":"Primary Contact Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "Timeframe":{
            "title":"Time Frame",
            "maxLength":"120",
            "type":"string",
            "description":"The timeframe associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "LeadOpportunity":{
            "title":"Opportunities",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadOpportunity-item-patch-request"
            }
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the owner of a sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AddrElementAttribute5":{
            "title":"Contact Address Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "BudgetCurrencyCode":{
            "title":"Budget Currency",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AddrElementAttribute1":{
            "title":"Contact Address Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "Assessments":{
            "title":"Lead Qualifications",
            "type":"array",
            "description":"The assessments resource is used to view, create and update qualifications of a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-item-patch-request"
            }
        },
        "sourceCodes":{
            "title":"Marketing Source Codes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-sourceCodes-item-patch-request"
            }
        },
        "ProgramName":{
            "title":"Partner Program",
            "type":"string",
            "description":"The name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramName"
                ]
            }
        },
        "AddrElementAttribute2":{
            "title":"Contact Address Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Contact Address Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesTargetLeadStage":{
            "title":"Stage",
            "maxLength":"32",
            "type":"string",
            "description":"The lead's current stage in the account based selling process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovalDate":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"The date on which a partner registered lead is approved by internal channel manager.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ApprovalDateTime"
                ]
            }
        },
        "AddrElementAttribute4":{
            "title":"Contact Address Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score associated with this sales lead. This score is computed based on the scoring rules.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "OpportunityName":{
            "title":"Opportunity Name",
            "type":"string",
            "description":"The name of the opportunity created from converting the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code",
            "maxLength":"10",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "PrimaryInventoryItemId":{
            "title":"Primary Product ID",
            "type":"integer",
            "description":"The unique identifier of the primary product associated with a lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "RejectComment":{
            "title":"Rejection Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The comments provided by the sales representative who rejected this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignmentStatusCode":{
            "title":"Assignment Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the current assignment related status for the lead, for example whether the lead is assigned or unassigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RawPrimaryPhoneNumber":{
            "title":"Raw Phone Number",
            "type":"string",
            "description":"The raw value of the lead primary phone number.",
            "nullable":true
        },
        "AllLeadAttachments":{
            "title":"Sales Leads Attachments",
            "type":"array",
            "description":"The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-AllLeadAttachments-item-patch-request"
            }
        },
        "CustomerPartyName":{
            "title":"Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true
        },
        "EnableCreateContact":{
            "title":"Create Contact",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new contact should be created during lead conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ReassignComment":{
            "title":"Reassign Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comment provided by a user while requesting the lead reassignment.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "CustomerNeed":{
            "title":"Customer Need",
            "maxLength":"30",
            "type":"string",
            "description":"The need the lead product serves for the lead customer.",
            "nullable":true,
            "x-queryable":false
        },
        "BudgetAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"The budget amount associated with this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactCity":{
            "title":"Primary Contact City",
            "maxLength":"60",
            "type":"string",
            "description":"The city where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "DecisionMakerIdentifiedFlag":{
            "title":"Decision Maker Identified",
            "maxLength":"120",
            "type":"boolean",
            "description":"Indicates if the decision maker at customer site has been identified.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "SalesChannel":{
            "title":"Sales Channel",
            "maxLength":"120",
            "type":"string",
            "description":"The sales channel responsible for following up on this sales lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerPartyName":{
            "title":"Primary Partner",
            "type":"string",
            "description":"The name of the partner associated with the sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerPartyName1"
                ]
            }
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name associated with the primary lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "FollowupTimestamp":{
            "title":"Next Follow-up Date",
            "type":"string",
            "description":"Indicates when the sales lead needs to be followed up.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "EstimatedCloseDate":{
            "title":"Estimated Close Date",
            "type":"string",
            "description":"The date when a registered deal is expected to close.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "MklLeadTcMembers1":{
            "title":"Sales Lead Contacts",
            "type":"array",
            "description":"The sales lead contacts resource is used to capture a contact associated with the sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-item-patch-request"
            }
        },
        "RejectedDateTime":{
            "title":"Rejected Time Stamp",
            "type":"string",
            "description":"The date and time when the sales lead is rejected.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDoNotPreference":{
            "title":"Don't Contact Preference",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates the don't contact preference of the sales lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"120",
            "type":"string",
            "description":"The registration type of the sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the sales lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkPhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code of the work phone associated with the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactAddress1":{
            "title":"Primary Contact Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "MklLeadResources":{
            "title":"Sales Lead Resources",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadResources-item-patch-request"
            }
        },
        "PrimaryContactAddress4":{
            "title":"Primary Contact Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PrimaryContactAddress3":{
            "title":"Primary Contact Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "SalesTargetLeadOptOutComment":{
            "title":"Opt-out Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments provided by the sales representative who opted out this lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactAddress2":{
            "title":"Primary Contact Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PrimaryInventoryOrgId":{
            "title":"Primary Product Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization to which the primary product associated with a lead belongs.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the Organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "QualifiedDateTime":{
            "title":"Qualification Date",
            "type":"string",
            "description":"The date and time when the sales lead is qualified.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactRelationshipId":{
            "title":"Primary Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship primary contact has with its parent organization.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrimaryCompetitorPartyId":{
            "title":"Primary Competitor Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary competitor of the lead. It is a reference key to competitor object.",
            "nullable":true,
            "x-hints":{
                "RecentItemEntityName":"competitors"
            }
        },
        "SalesTargetLeadOptOutDate":{
            "title":"Opt-out Date",
            "type":"string",
            "description":"The date of opting out the lead from sales target campaign.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Sales Leads Attachments",
    "type":"array",
    "description":"The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-AllLeadAttachments-item-patch-request"
    }
}

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

• Array of: object leads-Assessments-item-patch-request

{
    "title":"Lead Qualifications",
    "type":"array",
    "description":"The assessments resource is used to view, create and update qualifications of a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-item-patch-request"
    }
}

Nested Schema : Interviews

Type: array

Title: Interviews

The interviews resource is used to view and delete an interview record.

Show Source

• Array of: object leads-Interviews-item-patch-request

{
    "title":"Interviews",
    "type":"array",
    "description":"The interviews resource is used to view and delete an interview record.",
    "items":{
        "$ref":"#/components/schemas/leads-Interviews-item-patch-request"
    }
}

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

• Array of: object leads-LeadCampaigns-item-patch-request

{
    "title":"Lead Campaigns",
    "type":"array",
    "description":"The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadCampaigns-item-patch-request"
    }
}

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

• Array of: object leads-LeadCompetitors-item-patch-request

{
    "title":"Sales Lead Competitors",
    "type":"array",
    "description":"The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadCompetitors-item-patch-request"
    }
}

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

• Array of: object leads-LeadOpportunity-item-patch-request

{
    "title":"Opportunities",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadOpportunity-item-patch-request"
    }
}

Nested Schema : Lead Rollups

Type: array

Title: Lead Rollups

The lead rollups resource is used to view a sales lead rollup.

Show Source

• Array of: object leads-LeadRollup-item-patch-request

{
    "title":"Lead Rollups",
    "type":"array",
    "description":"The lead rollups resource is used to view a sales lead rollup.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadRollup-item-patch-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object leads-leadScoreDetails-item-patch-request

{
    "title":"Lead Score Details",
    "type":"array",
    "description":"The lead score details resource is used to view the details of lead conversion probability.",
    "items":{
        "$ref":"#/components/schemas/leads-leadScoreDetails-item-patch-request"
    }
}

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

• Array of: object leads-MklLeadResources-item-patch-request

{
    "title":"Sales Lead Resources",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadResources-item-patch-request"
    }
}

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

• Array of: object leads-MklLeadTcMembers1-item-patch-request

{
    "title":"Sales Lead Contacts",
    "type":"array",
    "description":"The sales lead contacts resource is used to capture a contact associated with the sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-item-patch-request"
    }
}

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

• Array of: object leads-MklLeadTeam-item-patch-request

{
    "title":"Lead Team",
    "type":"array",
    "description":"The lead teams resource is used to view the team members and territory team members associated with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTeam-item-patch-request"
    }
}

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

• Array of: object leads-MklLeadTerritoryAssoc-item-patch-request

{
    "title":"Sales Lead Territories",
    "type":"array",
    "description":"The sales lead territories resource is used to view the associated sales lead territories.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTerritoryAssoc-item-patch-request"
    }
}

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

• Array of: object leads-MklProdAssoc1-item-patch-request

{
    "title":"Sales Lead Products",
    "type":"array",
    "description":"The sales lead products resource is used to capture a product associated with the sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-MklProdAssoc1-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note resource is used to capture comments, information, or instructions for a sales lead.

Show Source

• Array of: object leads-Note-item-patch-request

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to capture comments, information, or instructions for a sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-Note-item-patch-request"
    }
}

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

• Array of: object leads-OrchestrationAssociations-item-patch-request

{
    "title":"Orchestration Associations",
    "type":"array",
    "description":"The orchestrations associations resource is used to view, create, update, and delete an orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-item-patch-request"
    }
}

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

• Array of: object leads-productGroups-item-patch-request

{
    "title":"Product Groups",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-productGroups-item-patch-request"
    }
}

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

• Array of: object leads-products-item-patch-request

{
    "title":"Products",
    "type":"array",
    "description":"The product resource is used to capture the name of the product associated with the sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-products-item-patch-request"
    }
}

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

• Array of: object leads-SalesContents-item-patch-request

{
    "title":"Sales Contents",
    "type":"array",
    "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-SalesContents-item-patch-request"
    }
}

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

• Array of: object leads-smartActions-item-patch-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-item-patch-request"
    }
}

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

• Array of: object leads-sourceCodes-item-patch-request

{
    "title":"Marketing Source Codes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-sourceCodes-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : leads-Assessments-item-patch-request

Type: object

Show Source

• 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.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of a lead qualification.
• 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.
• Name: string
  Title: Name

  Maximum Length: 255

  The name of the lead qualification.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language used for qualification of the lead.",
            "nullable":false,
            "default":"US"
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of a lead qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessedObjectId":{
            "title":"Assessed Object ID",
            "type":"integer",
            "description":"The unique identifier of the assessed business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the qualification.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "TotalAnswered":{
            "title":"Total Questions Answered",
            "type":"number",
            "description":"The number of questions responded in the qualification.",
            "nullable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-patch-request"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the lead qualification.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        }
    }
}

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

• Array of: object leads-Assessments-AssessAnswerGroups-item-patch-request

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-patch-request"
    }
}

Nested Schema : leads-Assessments-AssessAnswerGroups-item-patch-request

Type: object

Show Source

• AssessAnswerGroupId: integer (int64)
  The unique identifier of the answer group.
• AssessmentAnswer: array AssessmentAnswer
• AssessmentId: integer (int64)
  The unique identifier of the lead qualification template associated with answer group.

{
    "type":"object",
    "properties":{
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessmentAnswer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request"
            }
        }
    }
}

Nested Schema : AssessmentAnswer

Type: array

Show Source

• Array of: object leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request"
    }
}

Nested Schema : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-patch-request

Type: object

Show Source

• Answered: string
  Indicates if the question is answered or not.
• AnswerId: integer (int64)
  The unique identifier of the qualification answer.
• 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.

{
    "type":"object",
    "properties":{
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            }
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1500",
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            }
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-Interviews-item-patch-request

Type: object

Show Source

• AttachmentId: integer (int64)
  Title: Attachment ID

  The identifier for attachment of interview summary.
• 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.
• InterviewName: string
  Title: Interview Name

  Maximum Length: 100

  The name of the interview.
• InterviewStatus: string
  Title: Interview Status

  Maximum Length: 30

  Specifies the status of the interview
• OwnerResourceId: integer (int64)
  Title: Owner Resource ID

  The unique identifier of the user who created the 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.

{
    "type":"object",
    "properties":{
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier of top level object associated with the interview.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the top level object associated with the interview.",
            "nullable":false
        },
        "InterviewName":{
            "title":"Interview Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the interview.",
            "nullable":false
        },
        "InterviewStatus":{
            "title":"Interview Status",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the status of the interview",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InterviewDraft":{
            "title":"Interview Draft",
            "type":"string",
            "description":"The draft interview data. This allows a user to continue from the saved draft.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the user who created the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InterviewDataLang":{
            "title":"Interview Data Language",
            "maxLength":"30",
            "type":"string",
            "description":"The language in which interview has been submitted.",
            "nullable":true,
            "x-queryable":false
        },
        "InterviewData":{
            "title":"Interview Data",
            "type":"string",
            "description":"The submitted interview data containing questionnaires and responses.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The identifier for attachment of interview summary.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-LeadCampaigns-item-patch-request

Type: object

Show Source

• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The alternate identifier of the campaign number.
• PrimaryFlag: boolean
  Title: Primary

  Indicates whether the campaign is primary for the lead.

{
    "type":"object",
    "properties":{
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the campaign number.",
            "nullable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the campaign is primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CampaignId"
                ]
            }
        }
    }
}

Nested Schema : leads-LeadCompetitors-item-patch-request

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 2000

  Indicates the comments of the competitor associated with the lead.
• 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.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"PrimaryFlag",
            "type":"boolean",
            "description":"Indicates whether the competitor is a primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CompetitorPartyId"
                ]
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"Indicates the comments of the competitor associated with the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "ThreatLevelCode":{
            "title":"Threat Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the threat level of the competitor associated with the lead.",
            "nullable":true
        }
    }
}

Nested Schema : leads-LeadOpportunity-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : leads-LeadRollup-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : leads-leadScoreDetails-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : leads-MklLeadResources-item-patch-request

Type: object

Show Source

• 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.
• FunctionalRole: string
  Title: Function

  Maximum Length: 30

  The role played by this Sale team resource for the handling of this sales lead.
• LeadResourceId: integer
  Title: Lead Resource ID

  The unique identifier of the sales 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.
• ResourceId: integer
  Title: Resource ID

  The unique identifier associated with this sales lead resource.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"FULL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales lead resource.",
            "nullable":false,
            "x-hints":{
                "RecentItemEntityName":"resources"
            }
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role played by this Sale team resource for the handling of this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadResourceId":{
            "title":"Lead Resource ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead resource.",
            "nullable":false
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-MklLeadTcMembers1-item-patch-request

Type: object

Show Source

• 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.
• ContactJobTitle: string
  Title: Job Title

  The label displaying the job title of a contact in his company.
• EmailAddress: string
  Title: Email

  The e-mail address associated with the sales lead contact.
• FormattedPhoneNumber: string
  Title: Phone

  The formatted phone number of the lead contact.
• LeadMemberId: integer (int64)
  Title: Lead Contact ID

  The unique identifier for the sales lead contact.
• PartyId: integer (int64)
  Title: Contact Party ID

  The unique identifier of the lead to which the contact is associated.
• PartyUsageCode: string
  Title: Party Usage Code

  Maximum Length: 30

  The party usage recorded for this lead contact in the customer master.
• 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.

{
    "type":"object",
    "properties":{
        "Role":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role of lead contact in the context of this lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The label displaying the job title of a contact in his company.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.",
            "nullable":true
        },
        "PartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the lead to which the contact is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            }
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadMemberId":{
            "title":"Lead Contact ID",
            "type":"integer",
            "description":"The unique identifier for the sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party usage recorded for this lead contact in the customer master.",
            "nullable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address associated with the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS",
                    "ISBLANK"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":"0"
        }
    }
}

Nested Schema : leads-MklLeadTeam-item-patch-request

Type: object

Show Source

• 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.
• LeadId: integer (int64)
  The unique identifier of the lead.
• LeadTeamId: integer (int64)
  The unique identifier of the lead team.
• ResourceId: integer (int64)
  Resource party identifier of the lead team member.
• TerritoryVersionId: number
  Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.

{
    "type":"object",
    "properties":{
        "AddedOnDateTime":{
            "title":"Join Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "TerritoryVersionId":{
            "type":"number",
            "description":"Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.",
            "nullable":true
        },
        "LeadId":{
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource party identifier of the lead team member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadTeamId":{
            "type":"integer",
            "description":"The unique identifier of the lead team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-MklLeadTerritoryAssoc-item-patch-request

Type: object

Show Source

• 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.
• LeadTerritoryId: integer (int64)
  Title: Lead Territory Identifier

  The unique identifier of the territory for a sales lead.
• TerritoryId: integer
  Title: Territory Identifier

  The unique identifier of the territory for a sales lead.
• TerritoryVersionId: integer (int64)
  Title: Territory Version Identifier

  Default Value: 1

  The unique identifier of the territory version.

{
    "type":"object",
    "properties":{
        "TerritoryId":{
            "title":"Territory Identifier",
            "type":"integer",
            "description":"The unique identifier of the territory for a sales lead.",
            "nullable":false,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "title":"Territory Version Identifier",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadTerritoryId":{
            "title":"Lead Territory Identifier",
            "type":"integer",
            "description":"The unique identifier of the territory for a sales lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"15"
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-MklProdAssoc1-item-patch-request

Type: object

Show Source

• 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.
• 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.
• LeadProductId: integer (int64)
  Title: Lead Product ID

  The unique identifier of the current 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.
• 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.

{
    "type":"object",
    "properties":{
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this product is a primary product for this lead.",
            "nullable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The product description where the product is associated with the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EstimatedUnitPrice":{
            "title":"Estimated Unit Price",
            "type":"number",
            "description":"The estimated unit price for this lead product.",
            "nullable":true
        },
        "InventoryItemId":{
            "title":"Inventory Number",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the sales lead product.",
            "nullable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The product quantity identified for this product on the lead.",
            "nullable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with the sales lead product resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":"0"
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LeadProductId":{
            "title":"Lead Product ID",
            "type":"integer",
            "description":"The unique identifier of the current sales lead product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure associated with this sales lead product line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            }
        },
        "AverageTimeToClose":{
            "title":"Average Time to Close",
            "type":"number",
            "description":"The average time to close for this sales lead product.",
            "nullable":true
        }
    }
}

Nested Schema : leads-Note-item-patch-request

Type: object

Show Source

• 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.
• 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.
• 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.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The code indicating the visibility level of the note, such as internal or external.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.",
            "nullable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique party identifier of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the note. A list of valid values defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the visibility level of the note, such as internal or external.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship populated when the note is associated with a sales lead contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The user provided title for the note.",
            "nullable":true
        }
    }
}

Nested Schema : leads-OrchestrationAssociations-item-patch-request

Type: object

Show Source

• 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.
• ErrorLogs: array Error Logs
  Title: Error Logs

  The error logs resource is used to view error logs associated to the orchestration associations.
• PerformAction: string
  Title: Action to Perform

  Maximum Length: 30

  The action that user can perform on this orchestration association.
• 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.

{
    "type":"object",
    "properties":{
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-Steps-item-patch-request"
            }
        },
        "StepsInExecutionPath":{
            "title":"Steps In Execution Path",
            "type":"array",
            "description":"The steps in execution path resource is used to view all the steps including future steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepsInExecutionPath-item-patch-request"
            }
        },
        "ActionParameters":{
            "title":"Action Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"List of parameters required to execute the action specified through PERFORM_ACTION field.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-ErrorLogs-item-patch-request"
            }
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-StageObjectives-item-patch-request"
            }
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the association.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PerformAction":{
            "title":"Action to Perform",
            "maxLength":"30",
            "type":"string",
            "description":"The action that user can perform on this orchestration association.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-Stages-item-patch-request"
            }
        },
        "StepTransitions":{
            "title":"Step Transitions",
            "type":"array",
            "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepTransitions-item-patch-request"
            }
        }
    }
}

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

• Array of: object leads-OrchestrationAssociations-ErrorLogs-item-patch-request

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-ErrorLogs-item-patch-request"
    }
}

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

• Array of: object leads-OrchestrationAssociations-StageObjectives-item-patch-request

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-StageObjectives-item-patch-request"
    }
}

Nested Schema : Stages

Type: array

Title: Stages

The stages resource is used to view the stage of the orchestration association.

Show Source

• Array of: object leads-OrchestrationAssociations-Stages-item-patch-request

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-Stages-item-patch-request"
    }
}

Nested Schema : Steps

Type: array

Title: Steps

The steps resource is used to view the steps of the orchestration association.

Show Source

• Array of: object leads-OrchestrationAssociations-Steps-item-patch-request

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-Steps-item-patch-request"
    }
}

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

• Array of: object leads-OrchestrationAssociations-StepsInExecutionPath-item-patch-request

{
    "title":"Steps In Execution Path",
    "type":"array",
    "description":"The steps in execution path resource is used to view all the steps including future steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepsInExecutionPath-item-patch-request"
    }
}

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

• Array of: object leads-OrchestrationAssociations-StepTransitions-item-patch-request

{
    "title":"Step Transitions",
    "type":"array",
    "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepTransitions-item-patch-request"
    }
}

Nested Schema : leads-OrchestrationAssociations-ErrorLogs-item-patch-request

Type: object

Show Source

• ErrorDescription: string (byte)
  Title: Error Description

  The description of the error.
• ErrorText: string
  Title: Error Text

  Maximum Length: 2000

  The brief error details.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique 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.

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":"2000",
            "type":"string",
            "description":"The brief error details.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-OrchestrationAssociations-StageObjectives-item-patch-request

Type: object

Show Source

• DisplaySequence: integer
  Title: Display Sequence

  The order in which the Stages to be executed or displayed in the User Interface.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The status of the orchestration stage objective transition.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the Stages to be executed or displayed in the User Interface.",
            "nullable":true
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stage objective transition.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : leads-OrchestrationAssociations-Stages-item-patch-request

Type: object

Show Source

• CompletedObjsCnt: integer
  Title: Completed Objectives Count

  The count of completed objectives.
• 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.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• PendingObjectivesCount: integer
  Title: Pending Objectives Count

  Number of pending objectives.
• 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.
• TotalObjsCnt: integer
  Title: Total Objectives Count

  The total number of objectives.

{
    "type":"object",
    "properties":{
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"The count of skipped or not helpful objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"The total number of objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Order in which the Stages to be executed/shown back in UI.",
            "nullable":true
        },
        "StageStartDate":{
            "title":"Stage Start Date",
            "type":"string",
            "description":"The date and time when the stage execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StageEndDate":{
            "title":"Stage End Date",
            "type":"string",
            "description":"The date and time when the stage execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrentStageFlag":{
            "title":"Current Stage",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS stage or the most recently updated stage.",
            "nullable":true,
            "x-queryable":false
        },
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"The count of completed objectives.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : leads-OrchestrationAssociations-Steps-item-patch-request

Type: object

Show Source

• 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.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The run time status of the orchestration stage objective transition.
• 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.

{
    "type":"object",
    "properties":{
        "StepStartDate":{
            "title":"Step Start Date",
            "type":"string",
            "description":"The date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentStepFlag":{
            "title":"Current Step",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step or the most recently updated step.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Order in which the Stages to be executed/shown back in UI.",
            "nullable":true
        },
        "StepEndDate":{
            "title":"Step End Date",
            "type":"string",
            "description":"The date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-OrchestrationAssociations-StepsInExecutionPath-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : leads-OrchestrationAssociations-StepTransitions-item-patch-request

Type: object

Show Source

• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the activity.
• 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.
• EmailType: string
  Title: Email Type

  Maximum Length: 30

  The type of the email to which the step transitions is associated with.
• 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.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the email to which the step transitions is associated with.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "WrapUpId":{
            "title":"Wrap-up ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of step.",
            "nullable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"Specifies the brief comments required for runtime step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchStepTransitionFlag":{
            "title":"Current Step Transition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS Step transition or the most recently updated step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and time when the step transition is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "InboundConvMsgId":{
            "title":"Inbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of inbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and time when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and time when the step transition started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessCriteriaEvalFlag":{
            "title":"Success Criteria Evaluation Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies the success criteria evaluation result for the step.",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStatus":{
            "title":"Transition Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration step transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RefreshPageFlag":{
            "title":"Refresh Page",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to refresh the whole page before surfacing the current step in the runtime UI.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OutboundConvMsgId":{
            "title":"Outbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of outbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : leads-productGroups-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : leads-products-item-patch-request

Type: object

Show Source

• Text: string
  Title: Keyword

  The text or keywords associated with the product.

{
    "type":"object",
    "properties":{
        "Text":{
            "title":"Keyword",
            "type":"string",
            "description":"The text or keywords associated with the product.",
            "nullable":true,
            "x-hints":{
                "operators":[
                ]
            }
        }
    }
}

Nested Schema : leads-SalesContents-item-patch-request

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":"50",
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE"
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":"64",
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":"4000",
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":"64",
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true
        },
        "ParentObjectType":{
            "maxLength":"128",
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false
        }
    }
}

Nested Schema : leads-smartActions-item-patch-request

Type: object

Show Source

• 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.
• 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.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object leads-smartActions-UserActionNavigation-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-UserActionNavigation-item-patch-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object leads-smartActions-UserActionRequestPayload-item-patch-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object leads-smartActions-UserActionURLBinding-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-UserActionURLBinding-item-patch-request"
    }
}

Nested Schema : leads-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• 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.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false
        }
    }
}

Nested Schema : leads-smartActions-UserActionRequestPayload-item-patch-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• 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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true
        }
    }
}

Nested Schema : leads-smartActions-UserActionURLBinding-item-patch-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• 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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        }
    }
}

Nested Schema : leads-sourceCodes-item-patch-request

Type: object

Show Source

• 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.
• 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.
• SourceCodeId: integer (int64)
  Title: Source Code ID

  The unique identifier of the source code.

{
    "type":"object",
    "properties":{
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign associated with this source code.",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates an active or inactive status of this source code.",
            "nullable":true,
            "default":true
        },
        "SourceCodeId":{
            "title":"Source Code ID",
            "type":"integer",
            "description":"The unique identifier of the source code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : leads-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "RejectByUserId":{
            "title":"Reject by User ID",
            "type":"integer",
            "description":"The unique identifier of the sales representative who rejected this sales lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RetiredDateTime":{
            "title":"Retired Time Stamp",
            "type":"string",
            "description":"The date and time when the sales lead is moved to a retired status.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "EligibleForConversionFlag":{
            "title":"Eligible for Conversion",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies whether the lead is eligible for conversion to opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group if this record represents a product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PrimaryContactProvince":{
            "title":"Primary Contact Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province where the primary contact of the lead is located.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"15"
            },
            "x-queryable":true
        },
        "PrimaryContactPostalCode":{
            "title":"Primary Contact Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The zip code where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealAmount":{
            "title":"Deal Size",
            "type":"number",
            "description":"The total amount attributed to a lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactPhonePreference":{
            "title":"Phone Preference",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"The unique identifier for the IB asset associated with the sales lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The Email address for the primary sales lead contact on the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PrimaryPhoneVerificationDate":{
            "title":"Primary Phone Verification Date",
            "type":"string",
            "description":"The verification date for lead primary phone.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactEmailPreference":{
            "title":"Email Preference",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "Distance":{
            "title":"Distance",
            "type":"number",
            "description":"The distance of the lead address from the current location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Latitude",
                    "Longitude"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SalesContents":{
            "title":"Sales Contents",
            "type":"array",
            "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-SalesContents-item-response"
            }
        },
        "PrimaryProductGroupId":{
            "title":"Primary Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the primary product group associated with a lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ConvertedDateTime":{
            "title":"Converted Date",
            "type":"string",
            "description":"The date and time when the sales lead is converted to an opportunity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this lead record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPhoneAreaCode":{
            "title":"Primary Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The primary phone area code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "PartnerProgramId":{
            "title":"Partner Program",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the primary product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier  of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the Customer. It is a reference to the customer record in the TCA schema.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            },
            "x-queryable":true
        },
        "LeadAging":{
            "title":"Age in Days",
            "type":"number",
            "description":"The number of days elapsed since the lead was created.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LeadCreationDate"
                ]
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the lead address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to delete the record. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Primary Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedAddress":{
            "title":"Primary Contact Address",
            "type":"string",
            "description":"The primary address of a lead's primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactAddress1",
                    "PrimaryContactAddress2",
                    "PrimaryContactAddress3",
                    "PrimaryContactAddress4",
                    "PrimaryContactCity",
                    "PrimaryContactCounty",
                    "PrimaryContactState",
                    "PrimaryContactPostalCode",
                    "PrimaryContactCountry",
                    "PrimaryContactCountryName",
                    "PrimaryContactProvince",
                    "AddressLinesPhonetic",
                    "AddrElementAttribute1",
                    "AddrElementAttribute2",
                    "AddrElementAttribute3",
                    "AddrElementAttribute4",
                    "AddrElementAttribute5",
                    "Building",
                    "FloorNumber"
                ]
            }
        },
        "Project":{
            "title":"Customer Project",
            "maxLength":"30",
            "type":"string",
            "description":"The customer project identified for this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "QualifiedDate":{
            "title":"Qualification Date",
            "type":"string",
            "description":"The date when this sales lead was qualified.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "QualifiedDateTime"
                ]
            }
        },
        "LeadCreatedBy":{
            "title":"Lead Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lead record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "OrganizationSize":{
            "title":"Organization Size",
            "maxLength":"30",
            "type":"string",
            "description":"The size of the Organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesTargetLeadEloquaSyncDate":{
            "title":"Last Sync to Marketing Date",
            "type":"string",
            "description":"The date on which the current sales target lead contacts are last synced to Eloqua.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastAssignmentDate":{
            "title":"Last Automatic Assignment Date",
            "type":"string",
            "description":"The date on which the lead was last reassigned.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Contact Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The primary phone number for the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to capture comments, information, or instructions for a sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-Note-item-response"
            }
        },
        "PrimaryProductGroupReferenceNumber":{
            "title":"Primary Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate key for the referenced primary product group.",
            "nullable":false,
            "x-queryable":true
        },
        "productGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-productGroups-item-response"
            }
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the asset associated with the sales lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber"
                ]
            },
            "x-queryable":true
        },
        "LeadRollup":{
            "title":"Lead Rollups",
            "type":"array",
            "description":"The lead rollups resource is used to view a sales lead rollup.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadRollup-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the sales lead record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IBAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The unique serial number for the IB asset associated with the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":"40",
            "type":"string",
            "description":"The specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesTargetLeadValidationDueDate":{
            "title":"Validation Due Date",
            "type":"string",
            "description":"The date on which the sales target lead validation is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerProgramNumber":{
            "title":"Partner Program Number",
            "maxLength":"30",
            "type":"string",
            "description":"The partner program number alternate key for the referenced partner program.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCode":{
            "title":"Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"The marketing source code associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignNameLOV"
                ]
            },
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Contact Address Floor Number",
            "maxLength":"40",
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when building number is provided.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead contact marked as a primary lead contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of a sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate owner number key for referenced owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadCompetitors":{
            "title":"Sales Lead Competitors",
            "type":"array",
            "description":"The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadCompetitors-item-response"
            }
        },
        "PrimaryContactMailPreference":{
            "title":"Mail Preference",
            "maxLength":"30",
            "type":"string",
            "description":"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. \nA 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.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactState":{
            "title":"Primary Contact State",
            "maxLength":"60",
            "type":"string",
            "description":"The state where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the sales lead contact.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneAreaCode":{
            "title":"Work Phone Area Code",
            "maxLength":"10",
            "type":"string",
            "description":"The area code of the work phone associated with the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The account number alternate key for referenced customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The product resource is used to capture the name of the product associated with the sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-products-item-response"
            }
        },
        "BudgetStatus":{
            "title":"Budget Status",
            "maxLength":"120",
            "type":"string",
            "description":"The budget status associated with the Budget Amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "SalesTargetLeadOptOutReasonCode":{
            "title":"Opt-out Reason",
            "maxLength":"32",
            "type":"string",
            "description":"The reason for opting out the lead from sales target campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            }
        },
        "InventoryItemDescription":{
            "title":"Product Item",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the product added to a lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique party identifier associated with the owner of this sales lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "RetireReasonCode":{
            "title":"Retire Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for retiring the lead. A list of valid values is defined in the lookup RetireReasonVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary competitor of the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RetireComment":{
            "title":"Retirement Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The comments recorded when the sales lead is moved to a retired status.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressLinesPhonetic":{
            "title":"Contact Phonetic Address",
            "maxLength":"560",
            "type":"string",
            "description":"The phonetic or kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign of the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            },
            "x-queryable":true
        },
        "leadScoreDetails":{
            "title":"Lead Score Details",
            "type":"array",
            "description":"The lead score details resource is used to view the details of lead conversion probability.",
            "items":{
                "$ref":"#/components/schemas/leads-leadScoreDetails-item-response"
            }
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalDateTime":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"The date and time when the sales lead is approved. This is only applicable to deal registrations.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetNumber":{
            "title":"Installed Base Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"The unique number for the IB asset associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadLastUpdatedBy":{
            "title":"Lead Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"campaigns"
            },
            "x-queryable":true
        },
        "Interviews":{
            "title":"Interviews",
            "type":"array",
            "description":"The interviews resource is used to view and delete an interview record.",
            "items":{
                "$ref":"#/components/schemas/leads-Interviews-item-response"
            }
        },
        "MklLeadTeam":{
            "title":"Lead Team",
            "type":"array",
            "description":"The lead teams resource is used to view the team members and territory team members associated with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTeam-item-response"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"120",
            "type":"string",
            "description":"The approval Status of the sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "maxLength":"30",
            "type":"string",
            "description":"The rank associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "MklLeadTerritoryAssoc":{
            "title":"Sales Lead Territories",
            "type":"array",
            "description":"The sales lead territories resource is used to view the associated sales lead territories.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTerritoryAssoc-item-response"
            }
        },
        "PrimaryPhoneVerificationStatus":{
            "title":"Primary Phone Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for lead primary phone.",
            "nullable":true,
            "x-queryable":false
        },
        "OpportunityOwnerNumber":{
            "title":"Opportunity Owner Number",
            "type":"string",
            "description":"The alternate identifier for the owner of the opportunity created from converting the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for rejecting the lead. A list of valid values is defined in the lookup RejectReasonVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "title":"Primary Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The primary phone country code for the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when a sales lead will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ToReassignFlag":{
            "title":"Reassign",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates leads that are either unassigned or have been selected for automatic reassignment.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "LeadCampaigns":{
            "title":"Lead Campaigns",
            "type":"array",
            "description":"The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadCampaigns-item-response"
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate partner number key for the referenced partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryContactPersonFirstName":{
            "title":"Primary Contact First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber1":{
            "title":"Contact Phone",
            "type":"string",
            "description":"The formatted phone number of the primary contact for the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReassignReasonCode":{
            "title":"Reassign Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for reassigning the lead. A list of valid values is defined in the lookup ReassignVA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "ChannelType":{
            "title":"Source",
            "maxLength":"30",
            "type":"string",
            "description":"The channel through which a lead contacted the company.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the lead data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "PartnerType":{
            "title":"Partner Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the primary partner associated with this sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartnerId"
                ]
            }
        },
        "PrimaryContactCountry":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PrimaryContactCountryName"
                ]
            },
            "x-queryable":true
        },
        "AILeadScore":{
            "title":"AI Lead Score",
            "type":"number",
            "description":"The AI calculated probability of the lead being converted to an opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPersonMiddleName":{
            "title":"Primary Contact Middle Name",
            "maxLength":"150",
            "type":"string",
            "description":"The middle name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "PrimaryCompetitorName":{
            "title":"Primary Competitor",
            "type":"string",
            "description":"The name of the primary competitor of the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCompetitorName1"
                ]
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Primary Partner Identifier",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "LeadLastUpdateDate":{
            "title":"Lead Last Update Date",
            "type":"string",
            "description":"The date when the lead record was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTimezoneCd":{
            "title":"Contact Time Zone",
            "maxLength":"35",
            "type":"string",
            "description":"The preferred time zone of the contact pursued on the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Product Group Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the lead address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary campaign of the lead.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryContactCounty":{
            "title":"Primary Contact County",
            "maxLength":"60",
            "type":"string",
            "description":"The county where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicates the current status of the lead. A list of valid values is defined in the lookup StatusCodeVA.",
            "nullable":true,
            "default":"UNQUALIFIED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the sales lead.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Lead Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the lead.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationAssociations":{
            "title":"Orchestration Associations",
            "type":"array",
            "description":"The orchestrations associations resource is used to view, create, update, and delete an orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-item-response"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-item-response"
            }
        },
        "LeadAcceptedFlag":{
            "title":"Accepted",
            "maxLength":"4",
            "type":"boolean",
            "description":"Indicates if the lead has been accepted.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnableCreateAccount":{
            "title":"Create Account",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new account should be created during lead conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "QualificationScore":{
            "title":"Qualification Score",
            "type":"integer",
            "description":"The qualification score for a lead.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "LeadOrigin":{
            "title":"Origin",
            "maxLength":"30",
            "type":"string",
            "description":"The origin of the lead.",
            "nullable":true,
            "default":"SALES_LEAD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClassCode4":{
            "title":"Auxiliary Classification Code 3",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ClassCode3":{
            "title":"Auxiliary Classification Code 2",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailVerificationDate":{
            "title":"Email Verification Date",
            "type":"string",
            "description":"The verification date for primary contact email address.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "MklProdAssoc1":{
            "title":"Sales Lead Products",
            "type":"array",
            "description":"The sales lead products resource is used to capture a product associated with the sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-MklProdAssoc1-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClassCode2":{
            "title":"Auxiliary Classification Code 1",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryInventoryItemNumber":{
            "title":"Primary Inventory Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The alternate key for referenced the primary inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PrimaryInventoryOrgId"
                ]
            },
            "x-queryable":true
        },
        "ClassCode1":{
            "title":"Industry Classification Code",
            "maxLength":"30",
            "type":"string",
            "description":"The auxiliary dimension for the Account.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactEmailVerificationStatus":{
            "title":"Email Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The verification status for primary contact email address.",
            "nullable":true,
            "x-queryable":false
        },
        "AcceptedDateTime":{
            "title":"Accepted Date",
            "type":"string",
            "description":"The date and time when the sales lead is accepted by a resource assigned to it.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPersonLastName":{
            "title":"Primary Contact Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the primary contact for a lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "Timeframe":{
            "title":"Time Frame",
            "maxLength":"120",
            "type":"string",
            "description":"The timeframe associated with this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactCountryName":{
            "title":"Country Name",
            "type":"string",
            "description":"The name of the country associated with the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadOpportunity":{
            "title":"Opportunities",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-LeadOpportunity-item-response"
            }
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the owner of a sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit Identifier",
            "type":"integer",
            "description":"The unique identifier of the Business Unit which is associated with the business unit of the sales lead creator.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            }
        },
        "AddrElementAttribute5":{
            "title":"Contact Address Attribute 5",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadCreationDate":{
            "title":"Lead Creation Date",
            "type":"string",
            "description":"The date when the lead was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BudgetCurrencyCode":{
            "title":"Budget Currency",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AddrElementAttribute1":{
            "title":"Contact Address Attribute 1",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "Assessments":{
            "title":"Lead Qualifications",
            "type":"array",
            "description":"The assessments resource is used to view, create and update qualifications of a lead.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-item-response"
            }
        },
        "sourceCodes":{
            "title":"Marketing Source Codes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-sourceCodes-item-response"
            }
        },
        "ProgramName":{
            "title":"Partner Program",
            "type":"string",
            "description":"The name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramName"
                ]
            }
        },
        "AddrElementAttribute2":{
            "title":"Contact Address Attribute 2",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Contact Address Attribute 3",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesTargetLeadStage":{
            "title":"Stage",
            "maxLength":"32",
            "type":"string",
            "description":"The lead's current stage in the account based selling process.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":"100",
            "type":"string",
            "description":"The asset serial number associated with the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalDate":{
            "title":"Registration Approval Date",
            "type":"string",
            "description":"The date on which a partner registered lead is approved by internal channel manager.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ApprovalDateTime"
                ]
            }
        },
        "AddrElementAttribute4":{
            "title":"Contact Address Attribute 4",
            "maxLength":"150",
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score associated with this sales lead. This score is computed based on the scoring rules.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity Name",
            "type":"string",
            "description":"The name of the opportunity created from converting the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code",
            "maxLength":"10",
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "PrimaryInventoryItemId":{
            "title":"Primary Product ID",
            "type":"integer",
            "description":"The unique identifier of the primary product associated with a lead.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "RejectComment":{
            "title":"Rejection Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The comments provided by the sales representative who rejected this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignmentStatusCode":{
            "title":"Assignment Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the current assignment related status for the lead, for example whether the lead is assigned or unassigned.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPrimaryPhoneNumber":{
            "title":"Raw Phone Number",
            "type":"string",
            "description":"The raw value of the lead primary phone number.",
            "nullable":true,
            "x-queryable":true
        },
        "AllLeadAttachments":{
            "title":"Sales Leads Attachments",
            "type":"array",
            "description":"The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-AllLeadAttachments-item-response"
            }
        },
        "CustomerPartyName":{
            "title":"Account Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableCreateContact":{
            "title":"Create Contact",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new contact should be created during lead conversion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ReassignComment":{
            "title":"Reassign Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comment provided by a user while requesting the lead reassignment.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The work phone number of the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "CustomerNeed":{
            "title":"Customer Need",
            "maxLength":"30",
            "type":"string",
            "description":"The need the lead product serves for the lead customer.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignName":{
            "title":"Campaign",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the campaign associated with this sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceCode"
                ]
            },
            "x-queryable":true
        },
        "BudgetAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"The budget amount associated with this sales lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactCity":{
            "title":"Primary Contact City",
            "maxLength":"60",
            "type":"string",
            "description":"The city where the primary contact of the lead is located.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "DecisionMakerIdentifiedFlag":{
            "title":"Decision Maker Identified",
            "maxLength":"120",
            "type":"boolean",
            "description":"Indicates if the decision maker at customer site has been identified.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "SalesChannel":{
            "title":"Sales Channel",
            "maxLength":"120",
            "type":"string",
            "description":"The sales channel responsible for following up on this sales lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcceptedDate":{
            "title":"Accepted Date",
            "type":"string",
            "description":"The date on which lead was accepted by a resource assigned to it.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AcceptedDateTime"
                ]
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to update the record. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerPartyName":{
            "title":"Primary Partner",
            "type":"string",
            "description":"The name of the partner associated with the sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerPartyName1"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact Name",
            "maxLength":"450",
            "type":"string",
            "description":"The name associated with the primary lead contact.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "FollowupTimestamp":{
            "title":"Next Follow-up Date",
            "type":"string",
            "description":"Indicates when the sales lead needs to be followed up.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "EstimatedCloseDate":{
            "title":"Estimated Close Date",
            "type":"string",
            "description":"The date when a registered deal is expected to close.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "MklLeadTcMembers1":{
            "title":"Sales Lead Contacts",
            "type":"array",
            "description":"The sales lead contacts resource is used to capture a contact associated with the sales lead.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-item-response"
            }
        },
        "RejectedDateTime":{
            "title":"Rejected Time Stamp",
            "type":"string",
            "description":"The date and time when the sales lead is rejected.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContactDoNotPreference":{
            "title":"Don't Contact Preference",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates the don't contact preference of the sales lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box",
                "AttributeType":"Checkbox"
            }
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"120",
            "type":"string",
            "description":"The registration type of the sales lead. This is a deal specific attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId"
                ]
            },
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the sales lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkPhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":"10",
            "type":"string",
            "description":"The country code of the work phone associated with the sales lead contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryContactAddress1":{
            "title":"Primary Contact Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "MklLeadResources":{
            "title":"Sales Lead Resources",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadResources-item-response"
            }
        },
        "PrimaryContactAddress4":{
            "title":"Primary Contact Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PrimaryContactAddress3":{
            "title":"Primary Contact Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "SalesTargetLeadOptOutComment":{
            "title":"Opt-out Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments provided by the sales representative who opted out this lead.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactAddress2":{
            "title":"Primary Contact Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of address associated with the primary contact of the lead.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PrimaryInventoryOrgId":{
            "title":"Primary Product Organization ID",
            "type":"integer",
            "description":"The unique identifier of the organization to which the primary product associated with a lead belongs.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationType":{
            "title":"Organization Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the Organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "QualifiedDateTime":{
            "title":"Qualification Date",
            "type":"string",
            "description":"The date and time when the sales lead is qualified.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryContactRelationshipId":{
            "title":"Primary Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship primary contact has with its parent organization.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrimaryCompetitorPartyId":{
            "title":"Primary Competitor Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary competitor of the lead. It is a reference key to competitor object.",
            "nullable":true,
            "x-hints":{
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "SalesTargetLeadOptOutDate":{
            "title":"Opt-out Date",
            "type":"string",
            "description":"The date of opting out the lead from sales target campaign.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

• Array of: object leads-AllLeadAttachments-item-response

{
    "title":"Sales Leads Attachments",
    "type":"array",
    "description":"The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-AllLeadAttachments-item-response"
    }
}

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

• Array of: object leads-Assessments-item-response

{
    "title":"Lead Qualifications",
    "type":"array",
    "description":"The assessments resource is used to view, create and update qualifications of a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-item-response"
    }
}

Nested Schema : Interviews

Type: array

Title: Interviews

The interviews resource is used to view and delete an interview record.

Show Source

• Array of: object leads-Interviews-item-response

{
    "title":"Interviews",
    "type":"array",
    "description":"The interviews resource is used to view and delete an interview record.",
    "items":{
        "$ref":"#/components/schemas/leads-Interviews-item-response"
    }
}

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

• Array of: object leads-LeadCampaigns-item-response

{
    "title":"Lead Campaigns",
    "type":"array",
    "description":"The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadCampaigns-item-response"
    }
}

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

• Array of: object leads-LeadCompetitors-item-response

{
    "title":"Sales Lead Competitors",
    "type":"array",
    "description":"The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadCompetitors-item-response"
    }
}

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

• Array of: object leads-LeadOpportunity-item-response

{
    "title":"Opportunities",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadOpportunity-item-response"
    }
}

Nested Schema : Lead Rollups

Type: array

Title: Lead Rollups

The lead rollups resource is used to view a sales lead rollup.

Show Source

• Array of: object leads-LeadRollup-item-response

{
    "title":"Lead Rollups",
    "type":"array",
    "description":"The lead rollups resource is used to view a sales lead rollup.",
    "items":{
        "$ref":"#/components/schemas/leads-LeadRollup-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object leads-leadScoreDetails-item-response

{
    "title":"Lead Score Details",
    "type":"array",
    "description":"The lead score details resource is used to view the details of lead conversion probability.",
    "items":{
        "$ref":"#/components/schemas/leads-leadScoreDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object leads-MklLeadResources-item-response

{
    "title":"Sales Lead Resources",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadResources-item-response"
    }
}

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

• Array of: object leads-MklLeadTcMembers1-item-response

{
    "title":"Sales Lead Contacts",
    "type":"array",
    "description":"The sales lead contacts resource is used to capture a contact associated with the sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-item-response"
    }
}

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

• Array of: object leads-MklLeadTeam-item-response

{
    "title":"Lead Team",
    "type":"array",
    "description":"The lead teams resource is used to view the team members and territory team members associated with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTeam-item-response"
    }
}

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

• Array of: object leads-MklLeadTerritoryAssoc-item-response

{
    "title":"Sales Lead Territories",
    "type":"array",
    "description":"The sales lead territories resource is used to view the associated sales lead territories.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTerritoryAssoc-item-response"
    }
}

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

• Array of: object leads-MklProdAssoc1-item-response

{
    "title":"Sales Lead Products",
    "type":"array",
    "description":"The sales lead products resource is used to capture a product associated with the sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-MklProdAssoc1-item-response"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note resource is used to capture comments, information, or instructions for a sales lead.

Show Source

• Array of: object leads-Note-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to capture comments, information, or instructions for a sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-Note-item-response"
    }
}

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

• Array of: object leads-OrchestrationAssociations-item-response

{
    "title":"Orchestration Associations",
    "type":"array",
    "description":"The orchestrations associations resource is used to view, create, update, and delete an orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-item-response"
    }
}

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

• Array of: object leads-productGroups-item-response

{
    "title":"Product Groups",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-productGroups-item-response"
    }
}

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

• Array of: object leads-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The product resource is used to capture the name of the product associated with the sales lead.",
    "items":{
        "$ref":"#/components/schemas/leads-products-item-response"
    }
}

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

• Array of: object leads-SalesContents-item-response

{
    "title":"Sales Contents",
    "type":"array",
    "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.",
    "items":{
        "$ref":"#/components/schemas/leads-SalesContents-item-response"
    }
}

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

• Array of: object leads-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-item-response"
    }
}

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

• Array of: object leads-sourceCodes-item-response

{
    "title":"Marketing Source Codes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-sourceCodes-item-response"
    }
}

Nested Schema : leads-AllLeadAttachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : leads-Assessments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead qualification template record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusFuse":{
            "title":"Status",
            "type":"string",
            "description":"The status of the qualification.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode",
                    "TotalAnswered",
                    "TotalQuestions"
                ]
            },
            "x-queryable":true
        },
        "RatingFeedback":{
            "title":"Feedback",
            "type":"string",
            "description":"The feedback mapped to the rating of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lead qualification template record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of assessed business object.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language used for qualification of the lead.",
            "nullable":false,
            "default":"US",
            "x-queryable":true
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The object type of the lead qualification template associated with the qualification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of the lead qualification.",
            "format":"int64",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISNOTBLANK"
                ],
                "precision":"10"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the valid status for the lead qualification. The valid values are IN_PROGRESS and COMPLETE.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TotalAnswered":{
            "title":"Total Questions Answered",
            "type":"number",
            "description":"The number of questions responded in the qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-response"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the lead qualification.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit required to create a lead qualification and corresponds to the business unit of business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of a lead qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessedObjectId":{
            "title":"Assessed Object ID",
            "type":"integer",
            "description":"The unique identifier of the assessed business object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template",
            "type":"string",
            "description":"The name of the lead qualification template.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RatingTerm":{
            "title":"Rating",
            "type":"string",
            "description":"The overall rating of the qualification as configured in the associated lead qualification template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the lead qualification template that served as the source of this qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the lead qualification template record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object leads-Assessments-AssessAnswerGroups-item-response

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-Assessments-AssessAnswerGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated lead qualification template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssessAnswerGroupId":{
            "type":"integer",
            "description":"The unique identifier of the answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of the answer group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentAnswer":{
            "title":"Assessment Answers",
            "type":"array",
            "description":"The assessment answer resource is used to view and update a response for a question in a question group.",
            "items":{
                "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
            }
        }
    }
}

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

• Array of: object leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answer resource is used to view and update a response for a question in a question group.",
    "items":{
        "$ref":"#/components/schemas/leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1500",
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            },
            "x-queryable":true
        },
        "ResponseValue":{
            "title":"Response",
            "type":"string",
            "description":"The response of the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":"500",
            "type":"string",
            "description":"The name of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-Interviews-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the interview record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the interview record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerResourceNumber":{
            "title":"Owner Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the interview record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InterviewId":{
            "title":"Interview ID",
            "type":"integer",
            "description":"The unique identifier of interview record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InterviewName":{
            "title":"Interview Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the interview.",
            "nullable":false,
            "x-queryable":true
        },
        "InterviewDataLang":{
            "title":"Interview Data Language",
            "maxLength":"30",
            "type":"string",
            "description":"The language in which interview has been submitted.",
            "nullable":true,
            "x-queryable":false
        },
        "InterviewData":{
            "title":"Interview Data",
            "type":"string",
            "description":"The submitted interview data containing questionnaires and responses.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentId":{
            "title":"Attachment ID",
            "type":"integer",
            "description":"The identifier for attachment of interview summary.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier of top level object associated with the interview.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"Specifies how many times the row has been updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the top level object associated with the interview.",
            "nullable":false,
            "x-queryable":true
        },
        "InterviewStatus":{
            "title":"Interview Status",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the status of the interview",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InterviewDraft":{
            "title":"Interview Draft",
            "type":"string",
            "description":"The draft interview data. This allows a user to continue from the saved draft.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterviewNumber":{
            "title":"Interview Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the interview record.",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerResourceId":{
            "title":"Owner Resource ID",
            "type":"integer",
            "description":"The unique identifier of the user who created the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerResourcePartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user who created the interview record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date and time when the interview record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-LeadCampaigns-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead campaign record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lead campaign record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when marketing integration campaign starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of marketing integration campaign.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the campaign is primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CampaignId"
                ]
            },
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign Name",
            "maxLength":"100",
            "type":"string",
            "description":"The campaign to which the current lead belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for the current lead.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadCampaignId":{
            "title":"Lead Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the lead campaign.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadCampaignNumber":{
            "title":"Lead Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the lead campaign. Public surrogate key for this table.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"campaigns"
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the campaign number.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when marketing integration campaign ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead. It is the reference key to lead header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the lead campaign data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of marketing integration campaign.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-LeadCompetitors-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead competitor record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompetitorPartyId":{
            "title":"Competitor Party ID",
            "type":"integer",
            "description":"The unique identifier of the competitor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadCompetitorId":{
            "title":"Lead Competitor ID",
            "type":"integer",
            "description":"The unique identifier of the lead competitor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lead competitor record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"PrimaryFlag",
            "type":"boolean",
            "description":"Indicates whether the competitor is a primary for the lead.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CompetitorPartyId"
                ]
            },
            "x-queryable":true
        },
        "CompetitorPartyName":{
            "title":"Competitor Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the competitor of the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"Indicates the comments of the competitor associated with the lead.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadCompetitorNumber":{
            "title":"Lead Competitor Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the lead competitor. Public surrogate key for this table.",
            "nullable":false,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorPartyNumber":{
            "title":"Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for competitor of the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ThreatLevelCode":{
            "title":"Threat Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the threat level of the competitor associated with the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the lead competitor data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the sales lead competitor record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-LeadOpportunity-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Account":{
            "title":"Customer Name",
            "type":"string",
            "description":"The account associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedAmount":{
            "title":"Expected Revenue",
            "type":"integer",
            "description":"The win probability percentage of the revenue amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCloseDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the opportunity closes.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The lead number of the lead from which the opportunity originated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesStageId":{
            "title":"Sales Stage ID",
            "type":"integer",
            "description":"The unique identifier of the sales stage of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevenueAmount":{
            "title":"Line Revenue",
            "type":"integer",
            "description":"The revenue amount of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the lead.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "RecentItemEntityName":"opportunities"
            },
            "x-queryable":true
        },
        "WinProbability":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The win probability of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "type":"string",
            "description":"The currency associated with the opportunity revenue amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesStageName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sales stage of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadName":{
            "title":"Lead Name",
            "type":"string",
            "description":"The lead name used for identifying the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The alternate key identifier of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the opportunity associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-LeadRollup-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastEmailSentDate":{
            "title":"Last Email Sent",
            "type":"string",
            "description":"The date when last email was sent in context of the sales lead.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfOpenActivities":{
            "title":"Total Open Activities",
            "type":"number",
            "description":"The total number of activities that are open for the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextTaskDue":{
            "title":"Next Task Due",
            "type":"string",
            "description":"The date when a task is due for a sales lead.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastTouchDate":{
            "title":"Last Touch Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastCompletedActivity":{
            "title":"Last Completed Activity",
            "type":"string",
            "description":"The date of last completed activity for a sales lead. Activity includes task, appointment, and call report.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalNotes":{
            "title":"Total Notes",
            "type":"number",
            "description":"The total number of public notes associated with a lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CallsMade":{
            "title":"Total Calls Made",
            "type":"number",
            "description":"The total number of outbound calls made in context of the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastCallMadeDate":{
            "title":"Last Call Made",
            "type":"string",
            "description":"The date when last outbound call was made in context of the sales lead.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfTouches":{
            "title":"Total Touches",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailsSent":{
            "title":"Total Emails Sent",
            "type":"number",
            "description":"The total number of emails sent in context of the sales lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead Identifier",
            "type":"integer",
            "description":"The unique identifier of the sales lead.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code for the Sales Lead Rollups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-leadScoreDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DataType":{
            "maxLength":"255",
            "type":"string",
            "description":"The data type associated with the value of the feature used for predictions from the AI models.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeatureValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The value of the feature used for predictions from the AI models.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeatureName":{
            "type":"string",
            "description":"The name of the feature used for predictions from the AI models.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-MklLeadResources-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales lead resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead resource is created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this sales lead resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record represents the primary resource on the lead. The primary resource on the lead is the same as the lead owner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"FULL",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the sales lead manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Team Member",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the sales lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role played by this Sale team resource for the handling of this sales lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address associated with the sales lead team resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "LeadResourceId":{
            "title":"Lead Resource ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the sales lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceOrgId":{
            "title":"Resource Organization ID",
            "type":"integer",
            "description":"The unique identifier of the resource organization associated with this sales lead resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RoleName":{
            "title":"Role",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role of the sales lead resource associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The contact number of the party associated with the lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales lead resource.",
            "nullable":false,
            "x-hints":{
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead resource.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryPhonePurpose":{
            "title":"Role",
            "maxLength":"30",
            "type":"string",
            "description":"The type of contact point used for updating underlying contact point TCA data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead sales team resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead resource.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-MklLeadTcMembers1-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead contact is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"Postal code part of the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the sales lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title associated with the lead contact. This is not the same as the job title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhonePreference":{
            "title":"Phone Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "OrgContactId":{
            "title":"Organization Contact ID",
            "type":"integer",
            "description":"The unique identifier of the Organization for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The label displaying the job title of a contact in his company.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactDoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":"1",
            "type":"boolean",
            "description":"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. \nA 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadMemberId":{
            "title":"Lead Contact ID",
            "type":"integer",
            "description":"The unique identifier for the sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            },
            "x-queryable":true
        },
        "ContactDoNotMailFlag":{
            "title":"Do Not Mail",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales lead person can be contacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party recorded as lead contact. Possible values are person, organization or group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name or surname of a lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "EmailPreference":{
            "title":"Email Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the lead contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"City associated with the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ContactDoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address associated with the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS",
                    "ISBLANK"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role of lead contact in the context of this lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the lead to which the contact is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"State part of the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party usage recorded for this lead contact in the customer master.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead contact.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the sales lead record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Existing Account",
            "maxLength":"900",
            "type":"string",
            "description":"The account name associated with lead contacts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryCustomerId":{
            "type":"integer",
            "description":"The account party identifier of the account associated to the lead contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-MklLeadTeam-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TerritoryName":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The create date and time of the lead team member.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the lead team member is the owner of the lead.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The access level granted to the lead team member, manager, and administrator of the organizations in the resource hierarchy.",
            "nullable":false,
            "readOnly":true,
            "default":"FULL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The conflict identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the lead team member is the territory owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "TerritoryOwnerResourceId"
                ]
            }
        },
        "LeadTeamId":{
            "type":"integer",
            "description":"The unique identifier of the lead team.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the business function of the territory.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "type":"integer",
            "description":"The unique identifier of the lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the lead team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddedOnDateTime":{
            "title":"Join Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user identifier of the user who created the lead team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the type of the territory.",
            "nullable":false,
            "readOnly":true,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the lead team member is the owner of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerId"
                ]
            }
        },
        "FunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the function or role of the lead team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TerritoryNumber":{
            "title":"Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "FunctionalRole":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the function or role of the lead team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LeadResourceId":{
            "type":"integer",
            "description":"The unique identifier of the lead resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceRoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The role name of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "type":"number",
            "description":"Version identifier of the territory for the resource that got assigned to the lead through territory-based assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Resource party identifier of the lead team member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"Primary formatted phone number for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhonePurpose":{
            "title":"Role",
            "maxLength":"30",
            "type":"string",
            "description":"Primary purpose of the phone for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the lead team was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the lead team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-MklLeadTerritoryAssoc-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryId":{
            "title":"Territory Identifier",
            "type":"integer",
            "description":"The unique identifier of the territory for a sales lead.",
            "nullable":false,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the lead territory record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerPartyId":{
            "title":"Partner Identifier",
            "type":"integer",
            "description":"The unique identifier of the partner associated with the territory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the lead territory record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate owner number key for referenced owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the territory associated with the lead.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "dependencies":[
                    "TerritoryId"
                ]
            },
            "x-queryable":true
        },
        "TerritoryNumber":{
            "title":"Territory Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identification number for the territory associated with the lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The primary person responsible for working on the lead.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory the lead is assigned to.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "title":"Territory Version Identifier",
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerPartyName":{
            "title":"Partner Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Owner Party Identifier",
            "type":"integer",
            "description":"The party identifier of the territory owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead label.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"15"
            }
        },
        "LeadTerritoryId":{
            "title":"Lead Territory Identifier",
            "type":"integer",
            "description":"The unique identifier of the territory for a sales lead.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"15"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-MklProdAssoc1-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead product is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this product is a primary product for this lead.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The product description where the product is associated with the lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EstimatedUnitPrice":{
            "title":"Estimated Unit Price",
            "type":"number",
            "description":"The estimated unit price for this lead product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Product Group Description",
            "maxLength":"1000",
            "type":"string",
            "description":"A brief description of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with the sales lead product resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Inventory Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The alternate key for referenced inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadProductId":{
            "title":"Lead Product ID",
            "type":"integer",
            "description":"The unique identifier of the current sales lead product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure associated with this sales lead product line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "AverageTimeToClose":{
            "title":"Average Time to Close",
            "type":"number",
            "description":"The average time to close for this sales lead product.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales lead product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this sales lead product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Number",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the lead product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the sales lead product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The product quantity identified for this product on the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadProductNumber":{
            "title":"Lead Product Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key of the lead product.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the sales lead product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead product.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-Note-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the note record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of a lead party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the visibility level of the note, such as internal or external.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship populated when the note is associated with a sales lead contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The system generated user key. It can come from external system also.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The user provided title for the note.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note associated with the lead. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the note record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique party identifier of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the note. A list of valid values defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The identifier for the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the note data was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-OrchestrationAssociations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-Steps-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"The count of skipped or not helpful objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the orchestration association.",
            "nullable":false,
            "x-queryable":true
        },
        "NextStepSmartActionId":{
            "title":"Next Step Smart Action ID",
            "type":"integer",
            "description":"The smart action identifier of the next step to be executed as part of the current Orchestration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"The count of completed objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NextStepId":{
            "title":"Next Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step to be executed as part of the current Orchestration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"The total number of objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":false,
            "x-queryable":true
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the association.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StepTransitions":{
            "title":"Step Transitions",
            "type":"array",
            "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepTransitions-item-response"
            }
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-ErrorLogs-item-response"
            }
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerformAction":{
            "title":"Action to Perform",
            "maxLength":"30",
            "type":"string",
            "description":"The action that user can perform on this orchestration association.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-Stages-item-response"
            }
        },
        "CurrentAssocFlag":{
            "title":"Current Association",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current ACTIVE association or the most recently updated association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepsInExecutionPath":{
            "title":"Steps In Execution Path",
            "type":"array",
            "description":"The steps in execution path resource is used to view all the steps including future steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepsInExecutionPath-item-response"
            }
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionParameters":{
            "title":"Action Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"List of parameters required to execute the action specified through PERFORM_ACTION field.",
            "nullable":true,
            "x-queryable":false
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-StageObjectives-item-response"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The alternate identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object leads-OrchestrationAssociations-ErrorLogs-item-response

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-ErrorLogs-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object leads-OrchestrationAssociations-StageObjectives-item-response

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-StageObjectives-item-response"
    }
}

Nested Schema : Stages

Type: array

Title: Stages

The stages resource is used to view the stage of the orchestration association.

Show Source

• Array of: object leads-OrchestrationAssociations-Stages-item-response

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-Stages-item-response"
    }
}

Nested Schema : Steps

Type: array

Title: Steps

The steps resource is used to view the steps of the orchestration association.

Show Source

• Array of: object leads-OrchestrationAssociations-Steps-item-response

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-Steps-item-response"
    }
}

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

• Array of: object leads-OrchestrationAssociations-StepsInExecutionPath-item-response

{
    "title":"Steps In Execution Path",
    "type":"array",
    "description":"The steps in execution path resource is used to view all the steps including future steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepsInExecutionPath-item-response"
    }
}

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

• Array of: object leads-OrchestrationAssociations-StepTransitions-item-response

{
    "title":"Step Transitions",
    "type":"array",
    "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-StepTransitions-item-response"
    }
}

Nested Schema : leads-OrchestrationAssociations-ErrorLogs-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":"2000",
            "type":"string",
            "description":"The brief error details.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorLogsId":{
            "title":"Error Logs ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration error logs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorLogsNumber":{
            "title":"Error Logs Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration error logs.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-OrchestrationAssociations-StageObjectives-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the Stages to be executed or displayed in the User Interface.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStageObjDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the stages in the orchestration admin run time UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "OrchestrationStageObjDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage objective object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjName":{
            "title":"Objective Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stage objective transition.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStageDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the stages in the orchestration admin run time UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "RunTimeStageObjectiveId":{
            "title":"Run Time Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStageObjNumber":{
            "title":"Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStageObjectiveNumber":{
            "title":"Run Time Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage objective object.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-OrchestrationAssociations-Stages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"The count of skipped or not helpful objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "StepsCountInExecutionPath":{
            "title":"Step Count in Execution Path",
            "type":"integer",
            "description":"Number of Steps in the execution path for the orchestration stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Order in which the Stages to be executed/shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"The count of completed objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"The total number of objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuntimeStageNumber":{
            "title":"Run Time Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stages runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationStageDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StageStartDate":{
            "title":"Stage Start Date",
            "type":"string",
            "description":"The date and time when the stage execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrentStageFlag":{
            "title":"Current Stage",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS stage or the most recently updated stage.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StageEndDate":{
            "title":"Stage End Date",
            "type":"string",
            "description":"The date and time when the stage execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RuntimeStageId":{
            "title":"Run Time Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stages runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-OrchestrationAssociations-Steps-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Order in which the Stages to be executed/shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StepEndDate":{
            "title":"Step End Date",
            "type":"string",
            "description":"The date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStepNumber":{
            "title":"Run Time Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration steps runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "StepStartDate":{
            "title":"Step Start Date",
            "type":"string",
            "description":"The date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentStepFlag":{
            "title":"Current Step",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step or the most recently updated step.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RunTimeStepId":{
            "title":"Run Time Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-OrchestrationAssociations-StepsInExecutionPath-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OrchestrationAssocId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "StepType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContainMultipleTasks":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step contains multiple tasks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StepEndDate":{
            "type":"string",
            "description":"Specifies the date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The runtime status of the orchestration steps.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExecutionMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"The execution type for the orchestration step. The possible values are Manual and Automatic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FulfillsObjectiveCnt":{
            "type":"integer",
            "description":"The count of objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepStartDate":{
            "type":"string",
            "description":"Specifies the date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrentStepFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step or the most recently updated step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStageObjId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StepSuggestionText":{
            "maxLength":"2000",
            "type":"string",
            "description":"Suggestion text of the Orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-OrchestrationAssociations-StepTransitions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the email to which the step transitions is associated with.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityOwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityWebConferenceURL":{
            "title":"Web Conference URL",
            "maxLength":"2000",
            "type":"string",
            "description":"The web conference join URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"Alternate identifier of the activity. System generated or can come from external system (user key).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExitOrchestrationFlag":{
            "title":"Exit Orchestration",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to exit the orchestration when stop step occurs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepTasksId":{
            "title":"Orchestration Step Tasks ID",
            "type":"integer",
            "description":"Unique identifier for the orchestration step tasks.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivitySMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"Smart action identifier. Foriegn key from zca_user_action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityTaskStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the activity. Defaulted to NOT_STARTED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and time when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepTransitionId":{
            "title":"Step Transition ID",
            "type":"integer",
            "description":"The alternate identifier of the orchestration step transition object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SuccessCriteriaEvalFlag":{
            "title":"Success Criteria Evaluation Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Specifies the success criteria evaluation result for the step.",
            "nullable":true,
            "x-queryable":false
        },
        "StepSuggestionText":{
            "title":"Step Suggestion Text",
            "maxLength":"2000",
            "type":"string",
            "description":"Suggestion text of the Orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date the task activity is due to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepType":{
            "title":"Step Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepTransitionNumber":{
            "title":"Step Transition Number",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the orchestration step transition object.",
            "nullable":false,
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Description",
            "type":"string",
            "description":"A text field for capturing some descriptive information about the activity.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WrapUpId":{
            "title":"Wrap-up ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of step.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchStepTransitionFlag":{
            "title":"Current Step Transition",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS Step transition or the most recently updated step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and time when the step transition is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "InboundConvMsgId":{
            "title":"Inbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of inbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and time when the step transition started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStatus":{
            "title":"Transition Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration step transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in guidance primary or secondary banner.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "RefreshPageFlag":{
            "title":"Refresh Page",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to refresh the whole page before surfacing the current step in the runtime UI.",
            "nullable":true,
            "x-queryable":false
        },
        "StepTaskDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "OutboundConvMsgId":{
            "title":"Outbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of outbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityPartialDescription":{
            "title":"Short Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A column that stores the first 4000 characters of activity description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"Specifies the brief comments required for runtime step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivitySMARTActionContext":{
            "title":"Smart Action Context",
            "maxLength":"4000",
            "type":"string",
            "description":"Stores metadata needed for smart action",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityWebConferenceId":{
            "title":"Web Conference ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the web conference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":"500",
            "type":"string",
            "description":"Subject or name ot title of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date and time of an appointment, or the completion time of a task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityOwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The primary resource on the activity. Supports resources only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityAppointmentStatusCode":{
            "title":"Appointment Status",
            "maxLength":"30",
            "type":"string",
            "description":"Denotes the status of the Appointment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-productGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"A brief description of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ModelName":{
            "type":"string",
            "description":"The model name associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelConfigAttributes":{
            "type":"string",
            "description":"The model configuration attributes associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "type":"string",
            "description":"The reference number of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuotableFlag":{
            "title":"Quotable",
            "type":"boolean",
            "description":"Indicates whether a product group is quotable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the product group was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-products-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the Product Group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"A brief description of the product.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the Inventory Organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the Inventory Item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Text":{
            "title":"Keyword",
            "type":"string",
            "description":"The text or keywords associated with the product.",
            "nullable":true,
            "x-hints":{
                "operators":[
                ]
            },
            "x-queryable":true
        },
        "CSSEnabled":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the Product is inactive.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "type":"boolean",
            "description":"Indicates if the Product is active. If the value is True, then the Product is active. The default value is True.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the Product is active.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the product.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ServiceRequestEnabledCode":{
            "type":"string",
            "description":"The code indicating if service requests are enabled for the associated product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductNum":{
            "title":"Product Number",
            "type":"string",
            "description":"The number of the product.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the product was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-SalesContents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":"50",
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CanDelete":{
            "type":"string",
            "description":"Indicates whether user can delete the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":"64",
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesContentId":{
            "title":"Sales Content ID",
            "type":"integer",
            "description":"The unique identifier of the sales content.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":"128",
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":"64",
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "CanUpdate":{
            "type":"string",
            "description":"Indicates whether user can update the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":"4000",
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"Indicates the type of content, for example pdf, png, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated to the sales content row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-smartActions-item-response

Type: object

Show Source

• 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
  Title: Smart Action User Interface Definitions

  The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• 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.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/leads-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object leads-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-UserActionNavigation-item-response"
    }
}

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

• Array of: object leads-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-UserActionRequestPayload-item-response"
    }
}

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

• Array of: object leads-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/leads-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : leads-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• 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.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique system assigned identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : leads-sourceCodes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this record is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCode":{
            "title":"Source Code",
            "maxLength":"100",
            "type":"string",
            "description":"The source code that represents this record.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SourceCodeId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this source code record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the campaign associated with this source code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates an active or inactive status of this source code.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CampaignUsage":{
            "title":"Campaign Type",
            "maxLength":"30",
            "type":"string",
            "description":"Campaign Usage associated with source code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign associated with this source code.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceCodeId":{
            "title":"Source Code ID",
            "type":"integer",
            "description":"The unique identifier of the source code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AllLeadAttachments

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/AllLeadAttachments

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The attachment resource is used to view, create, and update attachments of a sales lead. An attachment includes additional information about a sales lead.

Assessments

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The assessments resource is used to view, create and update qualifications of a lead.

AssignmentStatusVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_LEAD_ASGNT_STATUS_CODE%2CBindLookupCode%3D{AssignmentStatusCode}

The lookups resource is used to view standard lookup codes.

BudgetCurrenciesVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

BudgetStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_LEAD_BUDGET_STATUS_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpReferenceGroupName%3DMKL_LEAD_BUDGET_STATUS_SETID%2CpEnabledFlag%3DY

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

BusinessUnitPVO

Operation: /crmRestApi/resources/11.13.18.05/crmBusinessUnits

The CRM business units resource is used to view the business unit details.

CampaignVOVA

Operation: /crmRestApi/resources/11.13.18.05/campaigns

The campaigns resource is used to view, create, update, and delete campaigns. A campaign is an effort reach out to contacts and leads to convert them to a customer.

ChannelVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_LEAD_CHANNEL_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DMKL_LEAD_CHANNEL_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

CompetitorVA

Operation: /crmRestApi/resources/11.13.18.05/competitors

Parameters:

• finder: ActiveCompetitorsFinder

A competitor is an organization that competes with the deploying organization in sales situations. This object stores additional competitor attributes such as SWOT, products sold by competitors and their mappings to the deploying organization's products, details of win/loss reasons, and associations to competitive literature.

ContactPreferenceCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

ContactTimezoneVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_HZ_TIMEZONE_CODES%2CBindLookupCode%3D{ContactTimezoneCd}

The lookups resource is used to view standard lookup codes.

CountryVA

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

Parameters:

• finder: ObsoleteEnabledFlagFinder%3BBindObsoleteFlag%3DN%2CBindEnabledFlag%3DY

The territories resource is used to get a list of ISO standard territories.

EligibleForConversionFlagVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

FndTreeNodeAUXDIM1VA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: ClassCategoryFinder

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

FndTreeNodeAUXDIM2VA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: ClassCategoryFinder

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

FndTreeNodeAUXDIM3VA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: ClassCategoryFinder

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

FndTreeNodeINDTVA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: ClassCategoryFinder%3BBindClassCategory%3D{calculated value}

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

FndTreeNodeORGTPVA

Operation: /crmRestApi/resources/11.13.18.05/classCodes

Parameters:

• finder: ClassCategoryFinder%3BBindClassCategory%3D{calculated value}

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

Interviews

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Interviews

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The interviews resource is used to view and delete an interview record.

LeadAcceptedFlagVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_LEAD_ACCEPTED_FLAG%2CBindLookupCode%3D{LeadAcceptedFlag}

The lookups resource is used to view standard lookup codes.

LeadCampaigns

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCampaigns

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The lead campaign resource is used to view, create, update, and delete the association of a campaign with a lead.

LeadCompetitors

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadCompetitors

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The lead competitors resource is used to view, create, update, and delete the association of a campaign with a lead.

LeadOpportunity

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadOpportunity

Parameters:

• leadsUniqID: $request.path.leadsUniqID

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.

LeadOriginVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{LeadOrigin}%2CBindLookupType%3DORA_MKL_LEAD_ORIGIN

The lookups resource is used to view standard lookup codes.

LeadRollup

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/LeadRollup

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The lead rollups resource is used to view a sales lead rollup.

MklLeadResources

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadResources

Parameters:

• leadsUniqID: $request.path.leadsUniqID

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

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The sales lead contacts resource is used to capture a contact associated with the sales lead.

MklLeadTeam

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTeam

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The lead teams resource is used to view the team members and territory team members associated with a lead.

MklLeadTerritoryAssoc

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTerritoryAssoc

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The sales lead territories resource is used to view the associated sales lead territories.

MklProdAssoc1

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The sales lead products resource is used to capture a product associated with the sales lead.

Note

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Note

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The note resource is used to capture comments, information, or instructions for a sales lead.

OrchestrationAssociations

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The orchestrations associations resource is used to view, create, update, and delete an orchestration association.

OrgSizeLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_ORGANIZATION_SIZE

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

PartnerPickerVA

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

The partner list of values resource is used to view a list of partners.

PartnerProgramsVA

Operation: /crmRestApi/resources/11.13.18.05/partnerProgramsLOV

The partner programs list of values resource is used to view the services to find partner programs.

PartnerTypeVA

Operation: /crmRestApi/resources/11.13.18.05/partnerTypesLOV

Parameters:

• finder: PartnerTypesFinder%3BOwnerId%3D{PartnerId}

A list of business relationships shared with a partner.

PhoneCountryCodePVOVA

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The country codes resource is used to get the country codes for phone numbers. All responses for the country codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds). You need to have PER_MANAGE_PERSON_PHONE_PRIV.

PrimaryEmailPreferenceCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_CONTACT_PREFERENCE

The lookups resource is used to view standard lookup codes.

PrimaryMailPreferenceCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_CONTACT_PREFERENCE

The lookups resource is used to view standard lookup codes.

PrimaryPhonePreferenceCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_CONTACT_PREFERENCE

The lookups resource is used to view standard lookup codes.

ProductGroupExtnLovVA

Operation: /crmRestApi/resources/11.13.18.05/productGroups

Parameters:

• finder: ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL

Name for Product Group detail base public view object.

ProductTypeLookupVOVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_LEAD_PRODUCT_TYPE

The lookups resource is used to view standard lookup codes.

RankVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_LEAD_RANK_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DMKL_LEAD_RANK_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

RatedCurrenciesVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

ReassignVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_LEAD_REASSIGN_REASON_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DMKL_LEAD_REASSIGN_REASON_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

RegistrationStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_DEAL_APPROVAL_STATUS%2CBindLookupCode%3D{RegistrationStatus}

The lookups resource is used to view standard lookup codes.

RegistrationTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_DEAL_TYPE_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DMKL_DEAL_TYPE_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

RejectReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_REJECT_REASON_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DMKL_REJECT_REASON_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

ResourcePickerVA

Operation: /crmRestApi/resources/11.13.18.05/resources

Parameters:

• finder: FilterByManagerReportsFlagRF

A front office person. For example, sales persons or partner members can be tagged as resources.

RetireReasonVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_RETIRE_REASON_CD_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DMKL_RETIRE_REASON_CD_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

SalesCatalogExtnProductsLovVA

Operation: /crmRestApi/resources/11.13.18.05/products

Parameters:

• finder: ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL

The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.

SalesChannelFilteredVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeMultiCodesFinder%3BBindLookupType%3DZPM_SALES_CHANNEL%2CNewLookupCode1%3DZPM_DIRECT_CHANNEL_TYPES%2CNewLookupCode2%3DZPM_PARTNER_CHANNEL_TYPES

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

SalesContents

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/SalesContents

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The sales contents resource is used to view, create, update, and delete the sales content associated with a lead.

SalesTargetLeadOptOutReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DORA_MKL_LEAD_OPTOUT_RSN_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpEnabledFlag%3DY%2CpReferenceGroupName%3DORA_MKL_LEAD_OPTOUT_RSN_SETID

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

SalesTargetLeadStageVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_LEAD_STAGE

The lookups resource is used to view standard lookup codes.

SearchFilterVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_LEAD_SRCH_GROUP%2CBindLookupCode%3D{RecordSet}

The lookups resource is used to view standard lookup codes.

SourceCodePickerVA

Operation: /crmRestApi/resources/11.13.18.05/sourcecodes

Parameters:

• finder: SourceCodePickerFinder

A marketing source code is a unique identifier representing a marketing campaign and the underlying treatment and segment or list used within each execution. The source code is used to track responses and leads generated by each marketing campaign execution, which helps gauge the effectiveness of each initiative.

StatusCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKL_LEAD_STATUS%2CBindLookupCode%3D{StatusCode}

The lookups resource is used to view standard lookup codes.

TimeFrameCdVA

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpLookupType%3DMKL_LEAD_TIMELINE_SETID%2CpBusinessUnitId%3D{BusinessUnitId}%2CpReferenceGroupName%3DMKL_LEAD_TIMELINE_SETID%2CpEnabledFlag%3DY

The FND common set Id lookups resource is used to view, create, update, and delete lookups for the foundation common set Id.

YesNoLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

leadScoreDetails

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/leadScoreDetails

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The lead score details resource is used to view the details of lead conversion probability.

productGroups

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/productGroups

Parameters:

• leadsUniqID: $request.path.leadsUniqID

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

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/products

Parameters:

• leadsUniqID: $request.path.leadsUniqID

The product resource is used to capture the name of the product associated with the sales lead.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/smartActions

Parameters:

• leadsUniqID: $request.path.leadsUniqID

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.

sourceCodes

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/sourceCodes

Parameters:

• leadsUniqID: $request.path.leadsUniqID

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.

Back to Top

Examples

The following example shows how to update a sales lead by submitting a PATCH request on the REST resource using cURL.

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100070255847

Example of Request Body

The following example shows the request body to update a sales lead.

{
  "Score": 99,
  "Description": "Updated Lead Description"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "Name": "FirstName LastName 2/19/16 2:58 AM",
  "LeadNumber": "CDRM_170310",
  "OwnerPartyName": "Gabrielle   Lee",
  "StatusCode": "UNQUALIFIED",
  "Rank": "HOT",
  "SourceCode": null,
  "CustomerPartyName": "New Account Name",
  "CreationDate": "2016-02-19T10:58:43+00:00",
  "RegistrationNumber": null,
  "RegistrationType": null,
  "RegistrationStatus": null,
  "PrimaryContactPartyName": "FirstName LastName",
  "Timeframe": null,
  "LastUpdateDate": "2016-02-19T10:58:43+00:00",
  "LeadId": 300100070255847,
  "CreatedBy": "SALES_ADMIN",
  "LastUpdatedBy": "SALES_ADMIN",
  "LastUpdateLogin": "2C1D48368055738CE0539544F00AB05B",
  "Score": 99,
  "CustomerId": null,
  "BusinessUnitId": 204,
  "PrimaryContactId": null,
  "Description": "Updated Lead Description",
    ...
    .
    .
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100070255847/lov/RegistrationStatusVA",
      "name": "RegistrationStatusVA",
      "kind": "collection"
    },
        },
         ....
    .
    .
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100070255847/child/MklLeadTcMembers1",
      "name": "MklLeadTcMembers1",
      "kind": "collection"
    }
  }
}

Back to Top