Jump to

• Request
• Response
• Examples

Create an opportunity

post

/crmRestApi/resources/11.13.18.05/opportunities

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AiObjectHints: array Object Hints
  Title: Object Hints

  The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.
• Assessments: array Assessments
  Title: Assessments

  The assessments resource is used to view, create, update, and delete the assessment of an opportunity.
• AssetId: integer (int64)
  The unique identifier of the asset associated with the opportunity.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The alternate key identifier of the asset associated with the opportunity.
• AssetProduct: string
  Title: Asset

  The name of the asset product associated with the opportunity.
• AssignmentMode: string
  Title: Assignment Mode

  Maximum Length: 30

  Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.
• Attachment: array Opportunity Attachments
  Title: Opportunity Attachments

  The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities.
• BdgtAmount: number
  Title: Budget Amount

  The budget amount from the sales account.
• BdgtAmtCurcyCd: string
  Title: Budget Amount Currency

  Maximum Length: 15

  The currency code for budget amount from the sales account.
• BudgetAvailableDate: string (date)
  Title: Date Budget Available

  The date when the budget will be available.
• BudgetedFlag: boolean
  Title: Budgeted

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
• ChampionFlag: boolean
  Title: Key Internal Sponsor

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
• ChildRevenue: array Revenue Items
  Title: Revenue Items

  The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CrmConversionRate: number
  Title: Conversion Rate

  This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.
• CurrencyCode(required): string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the opportunity. 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.
• CustomerAccountId: integer (int64)
  Title: Billing Account

  The unique identifier of the customer account associated with the opportunity.
• DealHorizonCode: string
  Title: Estimated Deal Duration

  Maximum Length: 30

  The code indicating the estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DecisionLevelCode: string
  Title: Decision Level

  Maximum Length: 30

  The code indicating the job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• Description: string
  Title: Sales Objective

  Maximum Length: 2000

  The description of the opportunity including the sales objective. The description is added by the Sales Representative.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date when the opportunity is expected to close.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The expected revenue from the opportunity.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• IBAssetId: integer (int64)
  Title: Installed Base Asset

  The unique identifier of the installed base asset of the opportunity.
• Interviews: array Interviews
  Title: Interviews

  The interviews resource is used to view the list of interviews related to the opportunities.
• KeyContactId: integer (int64)
  Title: Primary Contact

  The unique identifier of the primary contact of the opportunity.
• LastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• LineOfBusinessCode: string
  Title: Line of Business

  Maximum Length: 30

  The line of business that owns the opportunity.
• Name(required): string
  Title: Name

  Maximum Length: 275

  The name of the opportunity.
• Note: array Notes
  Title: Notes

  The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.
• OpportunityCampaigns: array Opportunity Campaigns
  Title: Opportunity Campaigns

  The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.
• OpportunityCompetitor2: array Opportunity Competitors
  Title: Opportunity Competitors

  The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.
• OpportunityContact: array Opportunity Contacts
  Title: Opportunity Contacts

  The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
• OpportunityDeal: array Opportunity Deals
  Title: Opportunity Deals

  The opportunity deals resource is used to view the deals associated with an opportunity.
• OpportunityLead: array Opportunity Leads
  Title: Opportunity Leads

  The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.
• OpportunityOrigin: string
  Title: Opportunity Origin

  Maximum Length: 30

  Default Value: SALES_OPTY

  The value for the origin of the opportunity.
• OpportunityResource: array Opportunity Team Members
  Title: Opportunity Team Members

  The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.
• OpportunityRollup: array Opportunity Rollups
  Title: Opportunity Rollups

  The opportunity rollups resource is used to view an opportunity rollup.
• OpportunitySource1: array Opportunity Sources
  Title: Opportunity Sources

  The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.
• opportunityStageSnapshots: array Opportunity Stage Snapshots
  Title: Opportunity Stage Snapshots

  The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.
• OpportunitySubscription: array Opportunity Subscriptions
  Title: Opportunity Subscriptions

  The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.
• OpportunityTeam: array Opportunity Teams
  Title: Opportunity Teams

  The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.
• OpportunityTypeCode: string
  Title: Opportunity Type

  Maximum Length: 30

  Display the different types of opportunity such as new, renewal, and expansion.
• OptyCreatedBy: string
  Title: Opportunity Created By

  Maximum Length: 64

  The user who created the opportunity record.
• OptyCreationDate: string (date-time)
  Title: Opportunity Creation Date

  The date when the opportunity was created.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyLastUpdateDate: string (date-time)
  Title: Opportunity Last Updated Date

  The date when the record was last updated.
• OptyLastUpdatedBy: string
  Title: Opportunity Last Updated By

  Maximum Length: 64

  The user who last updated the opportunity record.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OrchestrationAssociations: array Orchestration Associations
  Title: Orchestration Associations

  The orchestrations associations resource is used to view, create, update, and delete an orchestration association.
• OwnerResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of a valid employee resource who owns and manages the opportunity.
• PrimaryCampaignId: integer (int64)
  Title: Primary Campaign ID

  The unique identifier of the primary campaign of the opportunity. It is a reference key to campaign object.
• PrimaryCampaignName: string
  Title: Primary Campaign

  The name of the primary campaign of the opportunity.
• PrimaryCampaignNumber: string
  Title: Primary Campaign Number

  Maximum Length: 30

  The alternate identifier for primary campaign of the opportunity.
• PrimaryCompetitorId: integer (int64)
  Title: Primary Competitor

  The unique identifier of the primary competitor for this opportunity.
• PrimaryOrganizationId(required): integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit to which this opportunity belongs.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The alternate key identifier of the opportunity's primary partner company.
• PrimaryPartnerId: integer (int64)
  Title: Primary Partner

  The unique identifier of the primary partner associated with the opportunity.
• PrimaryPartnerOrgPartyName: string
  Title: Primary Partner

  Maximum Length: 360

  The name of the primary partner associated with the opportunity.
• PrimaryRevenueId: integer (int64)
  Title: Summary Revenue Line ID

  The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.
• PrimarySubscriptionId: integer (int64)
  Title: Primary Subscription Id

  The unique identifier of the primary subscription of the opportunity.
• PrSrcNumber: string
  Title: Primary Source Number

  Maximum Length: 100

  The alternate key identifier of the primary marketing source or campaign that generated this opportunity.
• QuotedFlag: boolean
  Title: Quoted

  Maximum Length: 1

  Default Value: false

  Indicates whether a quote has been created for this Opportunity.
• ReasonWonLostCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The code indicating the reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• Registered: string
  Title: Registered

  Maximum Length: 30

  Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. The default value is No.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 30

  The registration status of the opportunity or deal created by a partner.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 30

  The registration type used by the partner to create the opportunity or deal.
• RenewalProcess: string
  Title: Renewal Process

  Maximum Length: 30

  The renewal process can be manual, do not renew, or automatic.
• Revenue: number
  Title: Amount

  Default Value: 0

  The estimated revenue amount from the opportunity.
• RevenuePartnerPrimary: array Opportunity Partners
  Title: Opportunity Partners

  The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.
• RiskLevelCode: string
  Title: Level of Risk

  Maximum Length: 30

  The code indicating the risk level of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The code indicating the sales channel for the opportunity. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
• SalesMethodId: integer (int64)
  Title: Sales Method

  The unique identifier of the sales method for this opportunity.
• SalesStageId: integer (int64)
  Title: Sales Stage

  The unique identifier for the sales stage of the opportunity.
• Selected: boolean
  This is used during mass update scenarios from UI.
• SetupRefCode: string
  Maximum Length: 80

  The public unique identifier for the CPQ configuration setup.
• 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.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The code indicating the status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• StrategicLevelCode: string
  Title: Strategic Value

  Maximum Length: 30

  The code indicating the strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• TargetPartyId: integer (int64)
  Title: Account

  The unique identifier of the sales account that owns the opportunity.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.
• winProbabilityDetails: array Win Probability Details
  Title: Win Probability Details

  The win probability details resource is used to view the details of the winning probability of an opportunity.

{
    "required":[
        "CurrencyCode",
        "Name",
        "PrimaryOrganizationId"
    ],
    "type":"object",
    "properties":{
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method for this opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary campaign of the opportunity.",
            "nullable":false
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.",
            "nullable":true
        },
        "Attachment":{
            "title":"Opportunity Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Attachment-item-post-request"
            }
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The expected revenue from the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "OpportunityContact":{
            "title":"Opportunity Contacts",
            "type":"array",
            "description":"The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityContact-item-post-request"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist",
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the opportunity.",
            "nullable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"275",
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "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/opportunities-OrchestrationAssociations-item-post-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/opportunities-smartActions-item-post-request"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the opportunity. 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":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OpportunityRollup":{
            "title":"Opportunity Rollups",
            "type":"array",
            "description":"The opportunity rollups resource is used to view an opportunity rollup.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityRollup-item-post-request"
            },
            "x-cardinality":"1"
        },
        "PrimaryCompetitorId":{
            "title":"Primary Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor for this opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors",
                "dependencies":[
                    "PriCompPartyUniqueName1",
                    "PrimaryCompetitorName"
                ]
            }
        },
        "PrimaryPartnerId":{
            "title":"Primary Partner",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            }
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"The unique identifier of the installed base asset of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "RevenuePartnerPrimary":{
            "title":"Opportunity Partners",
            "type":"array",
            "description":"The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-RevenuePartnerPrimary-item-post-request"
            }
        },
        "RiskLevelCode":{
            "title":"Level of Risk",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the risk level of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "AssignmentMode":{
            "title":"Assignment Mode",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity's primary partner company.",
            "nullable":false
        },
        "TargetPartyId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the sales account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            }
        },
        "OpportunityCompetitor2":{
            "title":"Opportunity Competitors",
            "type":"array",
            "description":"The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityCompetitor2-item-post-request"
            }
        },
        "winProbabilityDetails":{
            "title":"Win Probability Details",
            "type":"array",
            "description":"The win probability details resource is used to view the details of the winning probability of an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-winProbabilityDetails-item-post-request"
            }
        },
        "ChildRevenue":{
            "title":"Revenue Items",
            "type":"array",
            "description":"The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-item-post-request"
            }
        },
        "OptyCreatedBy":{
            "title":"Opportunity Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "PrSrcNumber":{
            "title":"Primary Source Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the primary marketing source or campaign that generated this opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ReasonWonLostCode":{
            "title":"Win/Loss Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "opportunityStageSnapshots":{
            "title":"Opportunity Stage Snapshots",
            "type":"array",
            "description":"The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-opportunityStageSnapshots-item-post-request"
            }
        },
        "SalesStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier for the sales stage of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"18",
                "Dependencies":"SalesMethodId,PrimaryOrganizationId"
            }
        },
        "Assessments":{
            "title":"Assessments",
            "type":"array",
            "description":"The assessments resource is used to view, create, update, and delete the assessment of an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-item-post-request"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"5"
            }
        },
        "OptyCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date when the opportunity was created.",
            "format":"date-time",
            "nullable":true
        },
        "OptyLastUpdatedBy":{
            "title":"Opportunity Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "KeyContactId":{
            "title":"Primary Contact",
            "type":"integer",
            "description":"The unique identifier of the primary contact of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts",
                "dependencies":[
                    "PriContactPartyNameTransientForLOV",
                    "PriContactPartyName1"
                ]
            }
        },
        "BdgtAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"The budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Note-item-post-request"
            }
        },
        "OpportunityResource":{
            "title":"Opportunity Team Members",
            "type":"array",
            "description":"The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityResource-item-post-request"
            }
        },
        "PrimaryPartnerOrgPartyName":{
            "title":"Primary Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary partner associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SetupRefCode":{
            "maxLength":"80",
            "type":"string",
            "description":"The public unique identifier for the CPQ configuration setup.",
            "nullable":true
        },
        "Revenue":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated revenue amount from the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber",
                    "AssetProductForExtnLOV"
                ]
            }
        },
        "OpportunityOrigin":{
            "title":"Opportunity Origin",
            "maxLength":"30",
            "type":"string",
            "description":"The value for the origin of the opportunity.",
            "nullable":true,
            "default":"SALES_OPTY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "x-queryable":false
        },
        "BudgetAvailableDate":{
            "title":"Date Budget Available",
            "type":"string",
            "description":"The date when the budget will be available.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Sales Objective",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the opportunity including the sales objective. The description is added by the Sales Representative.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OpportunityLead":{
            "title":"Opportunity Leads",
            "type":"array",
            "description":"The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityLead-item-post-request"
            }
        },
        "AiObjectHints":{
            "title":"Object Hints",
            "type":"array",
            "description":"The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.",
            "items":{
                "$ref":"#/components/schemas/opportunities-AiObjectHints-item-post-request"
            }
        },
        "OpportunityTypeCode":{
            "title":"Opportunity Type",
            "maxLength":"30",
            "type":"string",
            "description":"Display the different types of opportunity such as new, renewal, and expansion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimarySubscriptionId":{
            "title":"Primary Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the primary subscription of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OpportunitySubscription":{
            "title":"Opportunity Subscriptions",
            "type":"array",
            "description":"The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunitySubscription-item-post-request"
            }
        },
        "DealHorizonCode":{
            "title":"Estimated Deal Duration",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":"30",
            "type":"string",
            "description":"The renewal process can be manual, do not renew, or automatic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DecisionLevelCode":{
            "title":"Decision Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            }
        },
        "CustomerAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the customer account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "OpportunityDeal":{
            "title":"Opportunity Deals",
            "type":"array",
            "description":"The opportunity deals resource is used to view the deals associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityDeal-item-post-request"
            }
        },
        "BdgtAmtCurcyCd":{
            "title":"Budget Amount Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"The registration type used by the partner to create the opportunity or deal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryOrganizationId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit to which this opportunity belongs.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            }
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign of the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            }
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "Selected":{
            "type":"boolean",
            "description":"This is used during mass update scenarios from UI.",
            "nullable":true,
            "x-queryable":false
        },
        "StrategicLevelCode":{
            "title":"Strategic Value",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "AssetProduct":{
            "title":"Asset",
            "type":"string",
            "description":"The name of the asset product associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign of the opportunity. 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 the list of interviews related to the opportunities.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Interviews-item-post-request"
            }
        },
        "OpportunityTeam":{
            "title":"Opportunity Teams",
            "type":"array",
            "description":"The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityTeam-item-post-request"
            }
        },
        "BudgetedFlag":{
            "title":"Budgeted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "QuotedFlag":{
            "title":"Quoted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a quote has been created for this Opportunity.",
            "nullable":true,
            "default":false
        },
        "OpportunitySource1":{
            "title":"Opportunity Sources",
            "type":"array",
            "description":"The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunitySource1-item-post-request"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"30",
            "type":"string",
            "description":"The registration status of the opportunity or deal created by a partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "CrmConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.",
            "nullable":true
        },
        "OpportunityCampaigns":{
            "title":"Opportunity Campaigns",
            "type":"array",
            "description":"The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityCampaigns-item-post-request"
            }
        },
        "LineOfBusinessCode":{
            "title":"Line of Business",
            "maxLength":"30",
            "type":"string",
            "description":"The line of business that owns the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":"50",
            "type":"string",
            "description":"The code indicating the sales channel for the opportunity. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ChampionFlag":{
            "title":"Key Internal Sponsor",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "PrimaryRevenueId":{
            "title":"Summary Revenue Line ID",
            "type":"integer",
            "description":"The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Registered":{
            "title":"Registered",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. The default value is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the opportunity is expected to close.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            }
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":"30",
            "type":"string",
            "description":"This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Object Hints

Type: array

Title: Object Hints

The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.

Show Source

• Array of: object opportunities-AiObjectHints-item-post-request

{
    "title":"Object Hints",
    "type":"array",
    "description":"The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.",
    "items":{
        "$ref":"#/components/schemas/opportunities-AiObjectHints-item-post-request"
    }
}

Nested Schema : Assessments

Type: array

Title: Assessments

The assessments resource is used to view, create, update, and delete the assessment of an opportunity.

Show Source

• Array of: object opportunities-Assessments-item-post-request

{
    "title":"Assessments",
    "type":"array",
    "description":"The assessments resource is used to view, create, update, and delete the assessment of an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Assessments-item-post-request"
    }
}

Nested Schema : Opportunity Attachments

Type: array

Title: Opportunity Attachments

The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.

Show Source

• Array of: object opportunities-Attachment-item-post-request

{
    "title":"Opportunity Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Attachment-item-post-request"
    }
}

Nested Schema : Revenue Items

Type: array

Title: Revenue Items

The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.

Show Source

• Array of: object schema

{
    "title":"Revenue Items",
    "type":"array",
    "description":"The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-item-post-request"
    }
}

Nested Schema : Interviews

Type: array

Title: Interviews

The interviews resource is used to view the list of interviews related to the opportunities.

Show Source

• Array of: object opportunities-Interviews-item-post-request

{
    "title":"Interviews",
    "type":"array",
    "description":"The interviews resource is used to view the list of interviews related to the opportunities.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Interviews-item-post-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.

Show Source

• Array of: object opportunities-Note-item-post-request

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Note-item-post-request"
    }
}

Nested Schema : Opportunity Campaigns

Type: array

Title: Opportunity Campaigns

The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityCampaigns-item-post-request

{
    "title":"Opportunity Campaigns",
    "type":"array",
    "description":"The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityCampaigns-item-post-request"
    }
}

Nested Schema : Opportunity Competitors

Type: array

Title: Opportunity Competitors

The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.

Show Source

• Array of: object opportunities-OpportunityCompetitor2-item-post-request

{
    "title":"Opportunity Competitors",
    "type":"array",
    "description":"The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityCompetitor2-item-post-request"
    }
}

Nested Schema : Opportunity Contacts

Type: array

Title: Opportunity Contacts

The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.

Show Source

• Array of: object opportunities-OpportunityContact-item-post-request

{
    "title":"Opportunity Contacts",
    "type":"array",
    "description":"The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityContact-item-post-request"
    }
}

Nested Schema : Opportunity Deals

Type: array

Title: Opportunity Deals

The opportunity deals resource is used to view the deals associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityDeal-item-post-request

{
    "title":"Opportunity Deals",
    "type":"array",
    "description":"The opportunity deals resource is used to view the deals associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityDeal-item-post-request"
    }
}

Nested Schema : Opportunity Leads

Type: array

Title: Opportunity Leads

The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.

Show Source

• Array of: object opportunities-OpportunityLead-item-post-request

{
    "title":"Opportunity Leads",
    "type":"array",
    "description":"The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityLead-item-post-request"
    }
}

Nested Schema : Opportunity Team Members

Type: array

Title: Opportunity Team Members

The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityResource-item-post-request

{
    "title":"Opportunity Team Members",
    "type":"array",
    "description":"The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityResource-item-post-request"
    }
}

Nested Schema : Opportunity Rollups

Type: array

Title: Opportunity Rollups

The opportunity rollups resource is used to view an opportunity rollup.

Show Source

• Array of: object opportunities-OpportunityRollup-item-post-request

{
    "title":"Opportunity Rollups",
    "type":"array",
    "description":"The opportunity rollups resource is used to view an opportunity rollup.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityRollup-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Opportunity Sources

Type: array

Title: Opportunity Sources

The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.

Show Source

• Array of: object schema

{
    "title":"Opportunity Sources",
    "type":"array",
    "description":"The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunitySource1-item-post-request"
    }
}

Nested Schema : Opportunity Stage Snapshots

Type: array

Title: Opportunity Stage Snapshots

The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.

Show Source

• Array of: object opportunities-opportunityStageSnapshots-item-post-request

{
    "title":"Opportunity Stage Snapshots",
    "type":"array",
    "description":"The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-opportunityStageSnapshots-item-post-request"
    }
}

Nested Schema : Opportunity Subscriptions

Type: array

Title: Opportunity Subscriptions

The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.

Show Source

• Array of: object opportunities-OpportunitySubscription-item-post-request

{
    "title":"Opportunity Subscriptions",
    "type":"array",
    "description":"The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunitySubscription-item-post-request"
    }
}

Nested Schema : Opportunity Teams

Type: array

Title: Opportunity Teams

The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityTeam-item-post-request

{
    "title":"Opportunity Teams",
    "type":"array",
    "description":"The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityTeam-item-post-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 schema

{
    "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/opportunities-OrchestrationAssociations-item-post-request"
    }
}

Nested Schema : Opportunity Partners

Type: array

Title: Opportunity Partners

The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.

Show Source

• Array of: object schema

{
    "title":"Opportunity Partners",
    "type":"array",
    "description":"The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-RevenuePartnerPrimary-item-post-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 opportunities-smartActions-item-post-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/opportunities-smartActions-item-post-request"
    }
}

Nested Schema : Win Probability Details

Type: array

Title: Win Probability Details

The win probability details resource is used to view the details of the winning probability of an opportunity.

Show Source

• Array of: object opportunities-winProbabilityDetails-item-post-request

{
    "title":"Win Probability Details",
    "type":"array",
    "description":"The win probability details resource is used to view the details of the winning probability of an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-winProbabilityDetails-item-post-request"
    }
}

Nested Schema : opportunities-AiObjectHints-item-post-request

Type: object

Show Source

• EndDate: string (date-time)
  Title: End Date

  The date when the hint ends.
• Explanations: string (byte)
  The explanatory text for the reasoning behind predictions from the AI models.
• HintCode: string
  Title: Hint Code

  Maximum Length: 10

  The unique identifier of the hint.
• ObjectHintId: integer (int64)
  Title: Object Hint ID

  The unique identifier of the object hint.
• ObjectInstanceId: integer (int64)
  Title: Object ID

  The unique identifier of the object specified by OBJECT_TYPE column.
• ObjectType: string
  Title: Object Type

  Maximum Length: 30

  The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc.
• ObjectUuid: string
  Title: Object Unique ID

  Maximum Length: 50

  The unique identifier of the object which is an alternate key.
• PredWinProb: number
  Title: Predicted Win Probability

  The win probability predicted by the AI engine.
• RespResourceId: integer (int64)
  Title: Response Resource ID

  The resource ID of the user who provided feedback on the recommendation.
• StartDate: string (date-time)
  The date when the hint starts.
• TaskId: integer (int64)
  The unique identifier of the task that was created for the recommendation.
• TopHintFlag: boolean
  Maximum Length: 1

  Indicates the current highest ranked recommendation to display in the UI.
• UserResponse: string
  Title: User Response

  Maximum Length: 1

  The user's response to a recommendation.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"The unique identifier of the task that was created for the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectHintId":{
            "title":"Object Hint ID",
            "type":"integer",
            "description":"The unique identifier of the object hint.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TopHintFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the current highest ranked recommendation to display in the UI.",
            "nullable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the hint ends.",
            "format":"date-time",
            "nullable":true
        },
        "RespResourceId":{
            "title":"Response Resource ID",
            "type":"integer",
            "description":"The resource ID of the user who provided feedback on the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "HintCode":{
            "title":"Hint Code",
            "maxLength":"10",
            "type":"string",
            "description":"The unique identifier of the hint.",
            "nullable":false
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the hint starts.",
            "format":"date-time",
            "nullable":true
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"The win probability predicted by the AI engine.",
            "nullable":true
        },
        "UserResponse":{
            "title":"User Response",
            "maxLength":"1",
            "type":"string",
            "description":"The user's response to a recommendation.",
            "nullable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc.",
            "nullable":false
        },
        "ObjectUuid":{
            "title":"Object Unique ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the object which is an alternate key.",
            "nullable":false
        },
        "Explanations":{
            "type":"string",
            "description":"The explanatory text for the reasoning behind predictions from the AI models.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectInstanceId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object specified by OBJECT_TYPE column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : opportunities-Assessments-item-post-request

Type: object

Show Source

• AssessAnswerGroups: array Assessment Answer Groups
  Title: Assessment Answer Groups

  The assessment answer groups resource is used to view and update the question groups in an assessment.
• AssessedLanguage: string
  Title: Assessment Language

  Maximum Length: 4

  Default Value: US

  The language of the assessment.
• AssessedObjectId(required): integer (int64)
  Title: Assessed Object ID

  The unique identifier of the assessed business object.
• AssessedObjTypeCode(required): string
  Title: Object Type Code

  Maximum Length: 30

  The code indicating the type of the assessed business object.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of an assessment.
• AssessmentScore: integer (int64)
  Title: Score

  Default Value: 0

  The calculated score of assessment.
• AssessTemplateId(required): integer (int64)
  Title: Template Name

  The unique identifier of the assessment template that served as the source of this assessment.
• BusinessUnit: integer (int64)
  Title: Business Unit

  The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• Name(required): string
  Title: Name

  Maximum Length: 255

  The name of the assessment.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: INCOMPLETE

  The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE.
• TemplateName: string
  Title: Template

  The name of the assessment template.
• TemplateType: string
  Title: Template Type

  The type of the assessment template associated with the assessment.
• TotalAnswered: number
  Title: Total Questions Answered

  The number of questions answered in the assessment.
• TotalQuestions: number
  Title: Total Questions

  The total number of questions to be answered in the assessment.

{
    "required":[
        "AssessTemplateId",
        "AssessedObjTypeCode",
        "AssessedObjectId",
        "Name"
    ],
    "type":"object",
    "properties":{
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the assessed business object.",
            "nullable":false
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language of the assessment.",
            "nullable":false,
            "default":"US"
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the assessment.",
            "nullable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The type of the assessment template associated with the assessment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of assessment.",
            "format":"int64",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISNOTBLANK"
                ],
                "precision":"10"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the valid status of the assessment. 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 answered in the assessment.",
            "nullable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view and update the question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-item-post-request"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the assessment.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of an assessment.",
            "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"
            }
        },
        "TemplateName":{
            "title":"Template",
            "type":"string",
            "description":"The name of the assessment template.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            }
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the assessment template that served as the source of this assessment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : Assessment Answer Groups

Type: array

Title: Assessment Answer Groups

The assessment answer groups resource is used to view and update the question groups in an assessment.

Show Source

• Array of: object opportunities-Assessments-AssessAnswerGroups-item-post-request

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

Nested Schema : opportunities-Assessments-AssessAnswerGroups-item-post-request

Type: object

Show Source

• AssessAnswerGroupId: integer (int64)
  The unique identifier of the answer group.
• AssessmentAnswer: array AssessmentAnswer
• AssessmentId(required): integer (int64)
  The unique identifier of the assessment associated with answer group.
• AttributeGroupId(required): integer (int64)
  The unique identifier of the question group of the associated template.

{
    "required":[
        "AssessmentId",
        "AttributeGroupId"
    ],
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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 assessment associated with answer group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssessmentAnswer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request"
            }
        }
    }
}

Nested Schema : AssessmentAnswer

Type: array

Show Source

• Array of: object opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request

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

Nested Schema : opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-post-request

Type: object

Show Source

• Answered: string
  Indicates if the question is answered or not.
• AnswerId: integer (int64)
  The unique identifier of the assessment answer.
• AssessmentId: integer (int64)
  The unique identifier of the assessments associated with answer.
• AttributeGroupId: integer (int64)
  Title: Question Group

  The unique identifier of the question group associated with assessment answer.
• AttributeId: integer (int64)
  Title: Question

  The unique identifier of the question associated with assessment answer.
• AttributeValueId: integer (int64)
  Title: Response

  The unique identifier of the response.
• Comments: string
  Title: Comments

  Maximum Length: 1500

  The assessment runtime comments entered by end user.
• HasComments: string
  Indicates if the comments are present or not.

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the assessments associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1500",
            "type":"string",
            "description":"The assessment runtime comments entered by end user.",
            "nullable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "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 assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            }
        }
    }
}

Nested Schema : opportunities-Attachment-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of the data.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length 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 current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the data.",
            "nullable":false,
            "default":"FILE",
            "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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the 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 URL of the attachment.",
            "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. The default value is false.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ActualCloseDate: string (date)
  Title: Actual Close Date

  The date when the revenue line was closed.
• AmountAggregatedForScheduleFlag: boolean
  Title: Divide Amount by Transactions

  Maximum Length: 1

  The amounts are divided by the number of transactions based on the set schedule.
• BUOrgId(required): integer (int64)
  Title: Business Unit

  The unique identifier of the Business Unit that owns the opportunity.
• ChildSplitRevenue: array Child Split Revenues
  Title: Child Split Revenues

  The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
• CloseReasonCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The code indicating the reason for winning or losing the revenue. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON.
• Comments: string
  Title: Line Comments

  Maximum Length: 250

  The user-provided comments for the revenue line.
• CommitFlag: boolean
  Title: Forecast

  Maximum Length: 1

  Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContractEndDate: string (date-time)
  Title: Contract End Date

  The end date of the contract for the quote.
• ContractStartDate: string (date-time)
  Title: Contract Start Date

  The start date of the contract for the quote.
• ConversionRate: number
  Title: Conversion Rate

  The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
• ConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
• CostAmount: number
  Title: Cost

  Default Value: 0

  The cost amount for the opportunity.
• CreditRcptPartOrgPartyId: integer (int64)
  Title: Credit Recipient Partner

  The unique identifier of the credit recipient partner organization party.
• CrmConversionRate: number
  Title: CRM Conversion Rate

  The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
• CrmConversionRateType: string
  Title: CRM Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
• CrmCurcyCode: string
  Title: Currency

  Maximum Length: 15

  The common CRM currency code.
• CustomerAccountId: integer (int64)
  Title: Revenue Customer Account ID

  The unique identifier of the customer account that owns the opportunity.
• Description: string
  Title: Product

  Maximum Length: 240

  The user-provided description of the product associated with the revenue.
• Discount: number
  Title: Discount

  The discount percent.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date when the child revenue closes. The default value is the opportunity's close date.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• ExpectDlvryDate: string (date)
  Title: Expected Delivery Date

  The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.
• ExternalAssetKey: string
  Title: External Asset Key

  Maximum Length: 255

  The asset key from an external system.
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 255

  The root asset key of the parent from an external system.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 255

  The root asset key obtained from an external system.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• InventoryItemId: integer (int64)
  Title: Product

  The unique identifier of the product in the inventory.
• InventoryOrgId: integer (int64)
  Title: Product

  The unique identifier of the organization in the inventory.
• ItemNumberInternal: string
  Title: Item Number Internal

  Maximum Length: 300

  The unique internal identifier of the product that is associated with the revenue.
• MarginAmount: number
  Title: Margin

  Default Value: 0

  The margin amount for the opportunity.
• MonthlyRecurringRevenue: number
  Title: Monthly Recurring Revenue

  The monthly recurring revenue on the revenue line.
• MonthlyUsageRevenue: number
  Title: Monthly Usage Revenue

  The monthly usage revenue on the revenue line.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The non recurring revenue amount associated with the revenue line.
• NqSplitAllocTypeCode: string
  Title: Allocation Style

  Maximum Length: 30

  The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
• OptyId: integer (int64)
  Title: Revenue Opportunity ID

  The unique identified of the opportunity.
• OptyLeadId: integer (int64)
  Title: Opportunity Lead

  The unique Identifier of the lead associated with opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity associated to child revenue.
• OrganizationId: integer (int64)
  Title: Organization

  The unique identifier of the organization to which the product belongs.
• OwnerDealExpirationDate: string (date)
  Title: Effective End Date

  The date when the owner deal expires.
• OwnerDealProtectedDate: string (date)
  Title: Effective Start Date

  The date when the owner deal starts.
• OwnerLockAsgnFlag: boolean
  Title: Lock Credit Owner

  Maximum Length: 1

  Default Value: false

  Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked. The default value is N.
• ParentRevnId: integer (int64)
  Title: Parent Revenue ID

  The unique identifier of the parent revenue line, used for Lineset functionality.
• PartEngagementTypeCd: string
  Title: Lead Registration Type

  Maximum Length: 100

  The code indicating the type of partner engagement.
• PrCmptPartyId: integer (int64)
  Title: Competitor

  The unique identifier of the primary competitor of this child revenue.
• PriceTypeCode: string
  Title: Price Type

  Maximum Length: 30

  The code indicating the type of pricing associated with the revenue line. The list of valid values are Mixed, Usage, Recurring, and One Time.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The alternate key identifier of the revenue's primary partner company.
• ProdGroupId: integer (int64)
  Title: Product Group

  The unique identifier of the product group.
• ProdGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group associated with the revenue.
• ProductGroupReferenceNumber: string
  Title: Product Group Reference Number

  Maximum Length: 50

  The reference number of the product group.
• productGroups: array Product Groups
  Title: Product Groups

  The product group resource is used to view the product groups associated with an opportunity. 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 products resource is used to view the products associated with an opportunity.
• ProductType: string
  Title: Product Type

  The type of product on the revenue line, such as item or product group.
• PrPartOrgPartyId: integer (int64)
  Title: Partner

  The unique identifier of the primary revenue partner organization party.
• PrTerritoryVersionId: integer (int64)
  Title: Forecast Territory

  The unique identifier of the primary territory for this revenue item.
• PrTerritoryVersionIdForManual: string
  Title: Manually Assigned Territory Version ID

  The version ID of a territory that is to be manually assigned to the revenue record.
• Quantity: number
  Title: Quantity

  The quantity of product for this opportunity.
• RecurDownsideAmount: number
  Title: Recurring Worst Case

  The minimum revenue amount from the recurrence.
• RecurEndDate: string (date)
  Title: End By

  The date when the child revenue recurrence ends.
• RecurFrequencyCode: string
  Title: Frequency

  Maximum Length: 30

  The code that indicates the frequency of recurrence for the child revenue. A list of valid values is defined in the lookup MOO_RECURRING_FREQUENCY.
• RecurNumberPeriods: integer (int64)
  Title: End After

  The number of times the child revenue should recur.
• RecurParentRevnId: integer (int64)
  Title: Recurring Revenue Parent ID

  The unique identifier for the parent revenue of the recurring revenue lines.
• RecurPeriodOrEndDateCode: string
  Title: Recurrence Period or End Date Code

  Default Value: EndAfter

  The code that indicates if a date or the number of recurrences are specified to end the recurrences.
• RecurQuantity: number
  Title: Recurring Quantity

  The quantity of the child revenue recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line.
• RecurRevnAmount: number
  Title: Scheduled Revenue Amount

  The amount of revenue from the child revenue recurrence.
• RecurringRevenue: array Recurring Revenues
  Title: Recurring Revenues

  The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
• RecurStartDate: string (date)
  Title: Start Date

  The date when the recurrence starts.
• RecurTypeCode: string
  Title: Recurrence Type Code

  Maximum Length: 30

  The code indicating if the line is a standard revenue line or a recurring revenue line. A list of valid values is defined in the lookup MOO_REVN_RECUR_TYPE.
• RecurUnitPrice: number
  Title: Recurring Estimated Price

  The price of each child revenue recurrence.
• RecurUpsideAmount: number
  Title: Recurring Best Case

  The maximum revenue amount from the recurrence.
• ResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of the revenue owner.
• RevenueTerritory: array Opportunity Revenue Territories
  Title: Opportunity Revenue Territories

  The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
• RevenueTypeCategory: string
  Title: Revenue Type Category

  Maximum Length: 30

  The revenue category type on the opportunity revenue line.
• RevnAmount: number
  Title: Amount

  Default Value: 0

  The amount of revenue that is earned from this opportunity.
• RevnAmountCurcyCode(required): string
  Title: Line Currency

  Maximum Length: 15

  The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• RevnCategoryCode: string
  Title: Revenue Category

  Maximum Length: 30

  The code indicating the revenue category used in Revenue Line Set functionality. A list of valid values is defined in the lookup MOO_REVN_CATEGORY.
• RevnCreationDate: string (date-time)
  Title: Creation Date

  The date when the revenue item was created.
• RevnId: integer (int64)
  Title: Revenue ID

  The unique identifier of the revenue for the opportunity.
• RevnLastUpdateDate: string (date-time)
  Title: Update Date

  The date and time when the revenue record was last updated.
• RevnLineTypeCode: string
  Title: Revenue Line Type Code

  Maximum Length: 30

  The code indicating the type of revenue line, such as Opportunity Summary Revenue, Standard Revenue, and so on. A list of valid values is defined in the lookup MOO_REVN_LINE_TYPE.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
• RevnSequenceNumber: integer (int32)
  Title: Line Set

  The revenue sequence number.
• SalesAccountId: integer (int64)
  Title: Account

  The unique identifier of the opportunity sales account.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
• SalesCreditTypeCode: string
  Title: Sales Credit Type

  Maximum Length: 30

  Default Value: QUOTA

  The code indicating the type of the sales credit, such as quota or non-quota. A list of valid values is defined in the lookup MOO_SALES_CREDIT_TYPE.
• ScheduleAction: string
  Title: Schedule Action

  The transient attribute. Web services need to pass a value to indicate the action to be taken on recurring schedule such as create, delete, extend, and replace.
• ScheduleNonRecurringAmount: number
  Title: Nonrecurring Amount for Schedule

  The non recurring amount based on the set schedule.
• ScheduleRecurringAmount: number
  Title: Recurring Amount for Schedule

  The recurring amount based on the set schedule.
• ScheduleUsageAmount: number
  Title: Usage Amount for Schedule

  The usage amount based on the set schedule.
• SplitParentRevnId: integer (int64)
  Title: Split Parent Revenue ID

  The unique identifier of the split parent revenue.
• SplitPercent: number
  Title: Sales Credit

  The percentage of split revenue.
• SplitTypeCode: string
  Title: Split Type Code

  Maximum Length: 30

  The code indicating the Split type of the Revenue, such as ParentSplit or ChildSplit. A list of valid values is defined in the lookup MOO_REVN_SPLIT_TYPE.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.
• SubscriptionId: integer (int64)
  Title: Subscription Id

  The unique identifier of the subscription.
• SubscriptionLineId: integer (int64)
  Title: Subscription Line Id

  The unique identifier of the subscription line within a subscription.
• TargetPartyId: integer (int64)
  Title: Account Party ID

  The unique identifier of the sales account that owns the opportunity.
• TypeCode: string
  Title: Revenue Type

  Maximum Length: 30

  The code indicating the type of revenue earned from this opportunity. A list of valid values is defined in the lookup MOO_SETID_REVENUE_TYPE.
• UnitPrice: number
  Title: Estimated Price

  The estimated unit price for the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure code for the product.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line.
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.

{
    "required":[
        "BUOrgId",
        "RevnAmountCurcyCode"
    ],
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "AmountAggregatedForScheduleFlag":{
            "title":"Divide Amount by Transactions",
            "maxLength":"1",
            "type":"boolean",
            "description":"The amounts are divided by the number of transactions based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnCreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the revenue item was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CrmCurcyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The common CRM currency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevnCategoryCode":{
            "title":"Revenue Category",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the revenue category used in Revenue Line Set functionality. A list of valid values is defined in the lookup MOO_REVN_CATEGORY.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "RevenueTerritory":{
            "title":"Opportunity Revenue Territories",
            "type":"array",
            "description":"The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-RevenueTerritory-item-post-request"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity associated to child revenue.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure code for the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId",
                    "InventoryOrgId"
                ]
            }
        },
        "CommitFlag":{
            "title":"Forecast",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the revenue's primary partner company.",
            "nullable":false
        },
        "TargetPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the sales account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditRcptPartOrgPartyId":{
            "title":"Credit Recipient Partner",
            "type":"integer",
            "description":"The unique identifier of the credit recipient partner organization party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ScheduleRecurringAmount":{
            "title":"Recurring Amount for Schedule",
            "type":"number",
            "description":"The recurring amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyUsageRevenue":{
            "title":"Monthly Usage Revenue",
            "type":"number",
            "description":"The monthly usage revenue on the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurEndDate":{
            "title":"End By",
            "type":"string",
            "description":"The date when the child revenue recurrence ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Product",
            "type":"integer",
            "description":"The unique identifier of the product in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of product on the revenue line, such as item or product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "InventoryOrgId":{
            "title":"Product",
            "type":"integer",
            "description":"The unique identifier of the organization in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevnLineTypeCode":{
            "title":"Revenue Line Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of revenue line, such as Opportunity Summary Revenue, Standard Revenue, and so on. A list of valid values is defined in the lookup MOO_REVN_LINE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleUsageAmount":{
            "title":"Usage Amount for Schedule",
            "type":"number",
            "description":"The usage amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnLastUpdateDate":{
            "title":"Update Date",
            "type":"string",
            "description":"The date and time when the revenue record was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "OptyId":{
            "title":"Revenue Opportunity ID",
            "type":"integer",
            "description":"The unique identified of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SplitTypeCode":{
            "title":"Split Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the Split type of the Revenue, such as ParentSplit or ChildSplit. A list of valid values is defined in the lookup MOO_REVN_SPLIT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "productGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The product group resource is used to view the product groups associated with an opportunity. 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/opportunities-ChildRevenue-productGroups-item-post-request"
            }
        },
        "SubscriptionLineId":{
            "title":"Subscription Line Id",
            "type":"integer",
            "description":"The unique identifier of the subscription line within a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevnSequenceNumber":{
            "title":"Line Set",
            "type":"integer",
            "description":"The revenue sequence number.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "PartEngagementTypeCd":{
            "title":"Lead Registration Type",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the type of partner engagement.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"Monthly Recurring Revenue",
            "type":"number",
            "description":"The monthly recurring revenue on the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractStartDate":{
            "title":"Contract Start Date",
            "type":"string",
            "description":"The start date of the contract for the quote.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "Discount":{
            "title":"Discount",
            "type":"number",
            "description":"The discount percent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2",
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "Description":{
            "title":"Product",
            "maxLength":"240",
            "type":"string",
            "description":"The user-provided description of the product associated with the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ItemNumberInternal":{
            "title":"Item Number Internal",
            "maxLength":"300",
            "type":"string",
            "description":"The unique internal identifier of the product that is associated with the revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerDealProtectedDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date when the owner deal starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChildSplitRevenue":{
            "title":"Child Split Revenues",
            "type":"array",
            "description":"The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-ChildSplitRevenue-item-post-request"
            }
        },
        "NqSplitAllocTypeCode":{
            "title":"Allocation Style",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrCmptPartyId":{
            "title":"Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor of this child revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The products resource is used to view the products associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-products-item-post-request"
            }
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":"255",
            "type":"string",
            "description":"The asset key from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "title":"Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpectDlvryDate":{
            "title":"Expected Delivery Date",
            "type":"string",
            "description":"The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "PriceTypeCode":{
            "title":"Price Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of pricing associated with the revenue line. The list of valid values are Mixed, Usage, Recurring, and One Time.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurringRevenue":{
            "title":"Recurring Revenues",
            "type":"array",
            "description":"The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-RecurringRevenue-item-post-request"
            }
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0"
        },
        "RevnAmountCurcyCode":{
            "title":"Line Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ContractEndDate":{
            "title":"Contract End Date",
            "type":"string",
            "description":"The end date of the contract for the quote.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":"255",
            "type":"string",
            "description":"The root asset key of the parent from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "CrmConversionRate":{
            "title":"CRM Conversion Rate",
            "type":"number",
            "description":"The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Estimated Price",
            "type":"number",
            "description":"The estimated unit price for the product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":"255",
            "type":"string",
            "description":"The root asset key obtained from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":"50",
            "type":"string",
            "description":"The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "RecurQuantity":{
            "title":"Recurring Quantity",
            "type":"number",
            "description":"The quantity of the child revenue recurrence.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the revenue for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurTypeCode":{
            "title":"Recurrence Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating if the line is a standard revenue line or a recurring revenue line. A list of valid values is defined in the lookup MOO_REVN_RECUR_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the Business Unit that owns the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            }
        },
        "SplitParentRevnId":{
            "title":"Split Parent Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the split parent revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MarginAmount":{
            "title":"Margin",
            "type":"number",
            "description":"The margin amount for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"The version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0"
        },
        "RecurRevnAmount":{
            "title":"Scheduled Revenue Amount",
            "type":"number",
            "description":"The amount of revenue from the child revenue recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the recurrence starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "AttributeType":"Picklist",
                "Dependencies":"BUOrgId"
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-editable unique identifier for the child revenue. The default value is the revenue identifier.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OwnerDealExpirationDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date when the owner deal expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "ScheduleAction":{
            "title":"Schedule Action",
            "type":"string",
            "description":"The transient attribute. Web services need to pass a value to indicate the action to be taken on recurring schedule such as create, delete, extend, and replace.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true
        },
        "ScheduleNonRecurringAmount":{
            "title":"Nonrecurring Amount for Schedule",
            "type":"number",
            "description":"The non recurring amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyLeadId":{
            "title":"Opportunity Lead",
            "type":"integer",
            "description":"The unique Identifier of the lead associated with opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurUpsideAmount":{
            "title":"Recurring Best Case",
            "type":"number",
            "description":"The maximum revenue amount from the recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "PrPartOrgPartyId":{
            "title":"Partner",
            "type":"integer",
            "description":"The unique identifier of the primary revenue partner organization party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The reference number of the product group.",
            "nullable":false
        },
        "RecurDownsideAmount":{
            "title":"Recurring Worst Case",
            "type":"number",
            "description":"The minimum revenue amount from the recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"The unique identifier of the primary territory for this revenue item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SalesCreditTypeCode":{
            "title":"Sales Credit Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the sales credit, such as quota or non-quota. A list of valid values is defined in the lookup MOO_SALES_CREDIT_TYPE.",
            "nullable":true,
            "default":"QUOTA",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "RecurParentRevnId":{
            "title":"Recurring Revenue Parent ID",
            "type":"integer",
            "description":"The unique identifier for the parent revenue of the recurring revenue lines.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurPeriodOrEndDateCode":{
            "title":"Recurrence Period or End Date Code",
            "type":"string",
            "description":"The code that indicates if a date or the number of recurrences are specified to end the recurrences.",
            "nullable":true,
            "default":"EndAfter",
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RecurEndDate"
                ]
            }
        },
        "ParentRevnId":{
            "title":"Parent Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the parent revenue line, used for Lineset functionality.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurUnitPrice":{
            "title":"Recurring Estimated Price",
            "type":"number",
            "description":"The price of each child revenue recurrence.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of the revenue owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount associated with the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "RevenueTypeCategory":{
            "title":"Revenue Type Category",
            "maxLength":"30",
            "type":"string",
            "description":"The revenue category type on the opportunity revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization to which the product belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CrmConversionRateType":{
            "title":"CRM Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerAccountId":{
            "title":"Revenue Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurFrequencyCode":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the frequency of recurrence for the child revenue. A list of valid values is defined in the lookup MOO_RECURRING_FREQUENCY.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount",
                    "NonRecurringRevenue",
                    "RecurRevenue",
                    "UsageRevenue",
                    "RevnAmount"
                ]
            }
        },
        "CostAmount":{
            "title":"Cost",
            "type":"number",
            "description":"The cost amount for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "RevnAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of revenue that is earned from this opportunity.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount",
                    "NonRecurringRevenue",
                    "RecurRevenue",
                    "UsageRevenue"
                ]
            }
        },
        "SalesAccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the opportunity sales account.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TypeCode":{
            "title":"Revenue Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of revenue earned from this opportunity. A list of valid values is defined in the lookup MOO_SETID_REVENUE_TYPE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"BUOrgId"
            }
        },
        "Comments":{
            "title":"Line Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The user-provided comments for the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of product for this opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "RecurNumberPeriods":{
            "title":"End After",
            "type":"integer",
            "description":"The number of times the child revenue should recur.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ActualCloseDate":{
            "title":"Actual Close Date",
            "type":"string",
            "description":"The date when the revenue line was closed.",
            "format":"date",
            "nullable":true
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "CloseReasonCode":{
            "title":"Win/Loss Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for winning or losing the revenue. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"BUOrgId"
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the child revenue closes. The default value is the opportunity's close date.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : Child Split Revenues

Type: array

Title: Child Split Revenues

The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.

Show Source

• Array of: object schema

{
    "title":"Child Split Revenues",
    "type":"array",
    "description":"The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-ChildSplitRevenue-item-post-request"
    }
}

Nested Schema : Product Groups

Type: array

Title: Product Groups

The product group resource is used to view the product groups associated with an opportunity. 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 opportunities-ChildRevenue-productGroups-item-post-request

{
    "title":"Product Groups",
    "type":"array",
    "description":"The product group resource is used to view the product groups associated with an opportunity. 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/opportunities-ChildRevenue-productGroups-item-post-request"
    }
}

Nested Schema : Products

Type: array

Title: Products

The products resource is used to view the products associated with an opportunity.

Show Source

• Array of: object opportunities-ChildRevenue-products-item-post-request

{
    "title":"Products",
    "type":"array",
    "description":"The products resource is used to view the products associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-products-item-post-request"
    }
}

Nested Schema : Recurring Revenues

Type: array

Title: Recurring Revenues

The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.

Show Source

• Array of: object opportunities-ChildRevenue-RecurringRevenue-item-post-request

{
    "title":"Recurring Revenues",
    "type":"array",
    "description":"The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-RecurringRevenue-item-post-request"
    }
}

Nested Schema : Opportunity Revenue Territories

Type: array

Title: Opportunity Revenue Territories

The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.

Show Source

• Array of: object schema

{
    "title":"Opportunity Revenue Territories",
    "type":"array",
    "description":"The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-RevenueTerritory-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ExtnPartyName: string
  Title: Owner

  The name of the revenue owner.
• ExtnPartyNameLOVSwitcher: string
  The switcher for ist of values for the revenue owner, used in UI scenarios.
• ForecastTerritoryName: string
  Title: Territory Name

  Maximum Length: 60

  The name of the forecast territory.
• OwnerLockAsgnFlag: boolean
  Title: Lock Credit Owner

  Maximum Length: 1

  Default Value: false

  Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.
• PrTerritoryVersionId: integer (int64)
  Title: Forecast Territory

  Forecast territory version identifier.
• PrTerritoryVersionIdForManual: string
  Title: Manually Assigned Territory Version ID

  Indicates the version ID of a territory that is to be manually assigned to the revenue record.
• ResourcePartyId: integer (int64)
  Title: Owner

  The identifier of the resource associated with the child split revenue.
• RevnAmount: number
  Title: Line Revenue

  Default Value: 0

  The revenue amount.
• RevnAmountCurcyCode: string
  Title: Currency

  Maximum Length: 15

  The currency the amount on this revenue line is based on.
• RevnId: integer (int64)
  The unique identifier of the child split revenue.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  The unique number for the revenue line.
• SalesCreditTypeCode: string
  Title: Sales Credit Type

  Maximum Length: 30

  Default Value: QUOTA

  Indicates the type of credit.
• SplitPercent: number
  Title: Sales Credit

  The percentage of split revenue.

{
    "type":"object",
    "properties":{
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"Forecast territory version identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ExtnPartyName":{
            "title":"Owner",
            "type":"string",
            "description":"The name of the revenue owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExtnPartyNameLOVSwitcher":{
            "type":"string",
            "description":"The switcher for ist of values for the revenue owner, used in UI scenarios.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SalesCreditTypeCode"
                ]
            }
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"Indicates the version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesCreditTypeCode":{
            "title":"Sales Credit Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of credit.",
            "nullable":true,
            "default":"QUOTA",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number for the revenue line.",
            "nullable":false
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the child split revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The identifier of the resource associated with the child split revenue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ExtnPartyName",
                    "PartyName"
                ]
            }
        },
        "ForecastTerritoryName":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the forecast territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RevnAmountCurcyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency the amount on this revenue line is based on.",
            "nullable":false
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"The revenue amount.",
            "nullable":true,
            "default":"0"
        }
    }
}

Nested Schema : opportunities-ChildRevenue-productGroups-item-post-request

Type: object

Show Source

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

Nested Schema : opportunities-ChildRevenue-products-item-post-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 : opportunities-ChildRevenue-RecurringRevenue-item-post-request

Type: object

Show Source

• EffectiveDate: string (date)
  Title: Line Close Date

  Estimated close date for this revenue - defaulted from opportunity's close date.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The non recurring revenue amount on the revenue line.
• Quantity: number
  Title: Quantity

  Product quantity.
• RecurParentRevnId: integer (int64)
  Indicates the parent revenue id for the recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line.
• RevnAmount: number
  Title: Line Revenue

  Default Value: 0

  Revenue amount.
• RevnId: integer (int64)
  Revenue identifier.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line.

{
    "type":"object",
    "properties":{
        "RecurParentRevnId":{
            "type":"integer",
            "description":"Indicates the parent revenue id for the recurrence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"Revenue identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product quantity.",
            "nullable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"Revenue amount.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "EffectiveDate":{
            "title":"Line Close Date",
            "type":"string",
            "description":"Estimated close date for this revenue - defaulted from opportunity's close date.",
            "format":"date",
            "nullable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":"30",
            "type":"string",
            "description":"User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EffectiveEndDate: string (date)
  The date when the resource organization assignment to the territory ends.
• EffectiveStartDate: string (date)
  The date when the resource organization for the territory was assigned to the revenue line.
• Name1: string
  Title: Organization

  The name of the organization that the territory resource belongs to.
• RevnId: integer (int64)
  The unique identifier of the revenue.
• RevnTerrId: integer (int64)
  The unique identifier of the revenue territory.
• RoleId: integer
  The unique identifier of the resource's role.
• RoleName: string
  The name of the resource's role.
• TerritoryId: integer (int64)
  The unique identifier of the territory.
• TerritoryVersionId: integer (int64)
  The unique identifier of the territory version.

{
    "type":"object",
    "properties":{
        "TerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the resource organization assignment to the territory ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevnTerrId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the resource organization for the territory was assigned to the revenue line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "Name1":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the organization that the territory resource belongs to.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : opportunities-Interviews-item-post-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.
• 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
• 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"
            }
        },
        "InterviewId":{
            "title":"Interview ID",
            "type":"integer",
            "description":"The unique identifier of interview record.",
            "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
        },
        "InterviewNumber":{
            "title":"Interview Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the interview record.",
            "nullable":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 : opportunities-Note-item-post-request

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the relationship that is populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique party identifier for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• NoteNumber: string
  Maximum Length: 30

  The system generated number. It can be generated from external system also (user key).
• 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 used to classify a note, as asset or adjustment.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The identifier for the parent note.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on.
• 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":{
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique party identifier for the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code used to classify a note, as asset or adjustment.",
            "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
        },
        "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 that is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The system generated number. It can be generated from external system also (user key).",
            "nullable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.",
            "nullable":false
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The identifier for the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The user provided title for the note.",
            "nullable":true
        }
    }
}

Nested Schema : opportunities-OpportunityCampaigns-item-post-request

Type: object

Show Source

• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table.
• OptyCampaignId: integer (int64)
  Title: Opportunity Campaign ID

  The unique identifier of the opportunity campaign.
• OptyCampaignNumber: string
  Title: Opportunity Campaign Number

  Maximum Length: 30

  The unique alternate identifier for the Opportunity Campaign.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity. It is the reference key to opportunity header.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The alternate identifier for current opportunity.
• PrimaryFlag: boolean
  Title: Primary

  Indicates whether the campaign is primary for the opportunity.
• RevenuePercentage: number
  Title: Revenue Percentage

  To store the percentage value of the opportunity's revenue shared by one or more campaigns.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the campaign is primary for the opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CampaignId"
                ]
            }
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"campaigns"
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table.",
            "nullable":false
        },
        "RevenuePercentage":{
            "title":"Revenue Percentage",
            "type":"number",
            "description":"To store the percentage value of the opportunity's revenue shared by one or more campaigns.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyCampaignId":{
            "title":"Opportunity Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for current opportunity.",
            "nullable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity. It is the reference key to opportunity header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyCampaignNumber":{
            "title":"Opportunity Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the Opportunity Campaign.",
            "nullable":false
        }
    }
}

Nested Schema : opportunities-OpportunityCompetitor2-item-post-request

Type: object

Show Source

• CmptPartyId: integer (int64)
  Title: Party ID

  The unique identifier for the competitor party.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments about the opportunity's competitor.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• OptyCompetitorId: integer (int64)
  Title: Opportunity Competitor ID

  The unique identifier for the competitor of the opportunity.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier for the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• PartyName: string
  Title: Competitor

  Maximum Length: 360

  The name of the party.
• PrimaryFlg: string
  Title: Primary

  Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.
• ThreatLevelCode: string
  Title: Threat Level

  Maximum Length: 30

  The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

{
    "type":"object",
    "properties":{
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments about the opportunity's competitor.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyCompetitorId":{
            "title":"Opportunity Competitor ID",
            "type":"integer",
            "description":"The unique identifier for the competitor of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyName":{
            "title":"Competitor",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":false
        },
        "CmptPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the competitor party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            }
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. 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"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : opportunities-OpportunityContact-item-post-request

Type: object

Show Source

• AffinityLvlCd: string
  Title: Affinity Level

  Maximum Length: 30

  The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• Comments: string
  Title: Comments

  Maximum Length: 255

  The textual comments about the contact on the current opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContactedFlg: string
  Title: Contacted

  Maximum Length: 1

  Default Value: N

  Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
• ContactPointId: integer
  The unique identifier of the contact point for an opportunity contact.
• InfluenceLvlCd: string
  Title: Influence Level

  Maximum Length: 30

  The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• LastUpdateLogin: string
  Maximum Length: 32

  The session login associated to the user who last updated the record.
• OptyConId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the opportunity.
• OptyId: integer (int64)
  Title: Opportunity

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• PERPartyId: integer (int64)
  Title: Opportunity Contact

  The party identifier of the opportunity contact.
• PrimaryFlg: string
  Title: Primary

  Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.
• RelationshipId: integer (int64)
  The identifier of the relationship for the opportunity contact.
• RoleCd: string
  Title: Function

  Maximum Length: 30

  The code identifying the roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

{
    "type":"object",
    "properties":{
        "ContactedFlg":{
            "title":"Contacted",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "OptyConId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The textual comments about the contact on the current opportunity.",
            "nullable":true
        },
        "InfluenceLvlCd":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleCd":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifying the roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyId":{
            "title":"Opportunity",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The identifier of the relationship for the opportunity contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the contact point for an opportunity contact.",
            "nullable":true,
            "x-queryable":false
        },
        "AffinityLvlCd":{
            "title":"Affinity Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "x-queryable":false
        },
        "PERPartyId":{
            "title":"Opportunity Contact",
            "type":"integer",
            "description":"The party identifier of the opportunity contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            }
        }
    }
}

Nested Schema : opportunities-OpportunityDeal-item-post-request

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• DealId: integer
  Title: Deal ID

  The unique identifier of the deal.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate key identifier of the deal registration.
• OptyId: integer
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.

{
    "type":"object",
    "properties":{
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the deal.",
            "nullable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "nullable":false
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the deal registration.",
            "nullable":false
        }
    }
}

Nested Schema : opportunities-OpportunityLead-item-post-request

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• DealEstimatedCloseDate: string (date)
  Title: Deal Registration Estimated Close Date

  The date when the deal registration for the opportunity is estimated to be closed.
• DealExpirationDate: string (date)
  Title: Deal Expiration Date

  The date when the lead registration will expire.
• DealPartProgramId: integer (int64)
  Title: Partner Program ID

  The unique identifier of the partner program associated with the lead registration.
• DealType: string
  Title: Lead Registration Type

  Maximum Length: 30

  The deal or lead registration type for the opportunity.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 64

  The alternate key identifier of the lead.
• ObjectUsage: string
  Title: Object Usage

  Maximum Length: 30

  Indicates whether the current record represents a lead or a deal.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyLeadId: integer (int64)
  Title: Opportunity Lead ID

  The unique identifier of the lead for the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• PartnerTypeCd: string
  Title: Partner Type

  Maximum Length: 250

  The code indicating the type of the partner for the lead registration.
• PrDealPartOrgPartyId: integer (int64)
  Title: Partner Organization Party ID

  The unique identifier for the partner on the lead registration.
• PrDealPartResourcePartyId: integer (int64)
  Title: Primary Partner Resource ID

  The unique identifier for the primary partner resource on the lead registration.
• RegistrationNumber: string
  Title: Registration Number

  Maximum Length: 120

  The unique registration number of the lead for the opportunity.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date and time when the opportunity lead was last updated from mobile.

{
    "type":"object",
    "properties":{
        "DealType":{
            "title":"Lead Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"The deal or lead registration type for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "DealEstimatedCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration for the opportunity is estimated to be closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "SmartPickerEntityName":"Lead"
            }
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time when the opportunity lead was last updated from mobile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PrDealPartResourcePartyId":{
            "title":"Primary Partner Resource ID",
            "type":"integer",
            "description":"The unique identifier for the primary partner resource on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealExpirationDate":{
            "title":"Deal Expiration Date",
            "type":"string",
            "description":"The date when the lead registration will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "PrDealPartOrgPartyId":{
            "title":"Partner Organization Party ID",
            "type":"integer",
            "description":"The unique identifier for the partner on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealPartProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectUsage":{
            "title":"Object Usage",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the current record represents a lead or a deal.",
            "nullable":true,
            "x-queryable":false
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique registration number of the lead for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerTypeCd":{
            "title":"Partner Type",
            "maxLength":"250",
            "type":"string",
            "description":"The code indicating the type of the partner for the lead registration.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyLeadId":{
            "title":"Opportunity Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false
        }
    }
}

Nested Schema : opportunities-OpportunityResource-item-post-request

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• AsgnTerritoryVersionId: integer (int64)
  Title: Territory

  The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• DealExpirationDate: string (date)
  Title: Deal Protected to Date

  The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
• DealProtectedDate: string (date)
  Title: Deal Protected from Date

  The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
• LockAssignmentFlag: boolean
  Title: Lock Assignment

  Maximum Length: 1

  Default Value: true

  Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• OptyId: integer (int64)
  The unique Identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OptyResourceId: integer (int64)
  Title: Opportunity Resource ID

  The unique party identifier for the existing opportunity resource.
• OptyResourceNumber: string
  Title: Opportunity Resource Number

  Maximum Length: 30

  The alternate key identifier of the opportunity resource.
• OwnerFlag: boolean
  Title: Primary

  Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.
• PartnerOrgId: integer (int64)
  Title: Name

  The unique identifier of the partner organization.
• ResourceId: integer (int64)
  Title: Team Member

  The unique party identifier for the existing resource.

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "DealExpirationDate":{
            "title":"Deal Protected to Date",
            "type":"string",
            "description":"The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.",
            "format":"date",
            "nullable":true
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique Identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "DealProtectedDate":{
            "title":"Deal Protected from Date",
            "type":"string",
            "description":"The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.",
            "format":"date",
            "nullable":true
        },
        "ResourceId":{
            "title":"Team Member",
            "type":"integer",
            "description":"The unique party identifier for the existing resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            }
        },
        "OptyResourceNumber":{
            "title":"Opportunity Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OptyResourceId":{
            "title":"Opportunity Resource ID",
            "type":"integer",
            "description":"The unique party identifier for the existing opportunity resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartnerOrgId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LockAssignmentFlag":{
            "title":"Lock Assignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "AsgnTerritoryVersionId":{
            "title":"Territory",
            "type":"integer",
            "description":"The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false
        }
    }
}

Nested Schema : opportunities-OpportunityRollup-item-post-request

Type: object

Show Source

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

Nested Schema : schema

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• LastUpdateLogin: string
  Maximum Length: 32

  The session login associated to the user who last updated the record.
• OptyId: integer (int64)
  The unique Identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• OptySrcId: integer (int64)
  The unique Identifier of the source of the opportunity.
• SrcNumber: string
  Title: Source Code

  Maximum Length: 100

  A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on.
• UserLastUpdateDate: string (date-time)
  The date and time when the opportunity was last updated from mobile.

{
    "type":"object",
    "properties":{
        "SrcNumber":{
            "title":"Source Code",
            "maxLength":"100",
            "type":"string",
            "description":"A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the opportunity was last updated from mobile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique Identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "OptySrcId":{
            "type":"integer",
            "description":"The unique Identifier of the source of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : opportunities-opportunityStageSnapshots-item-post-request

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the opportunity stage snapshot is active.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyStgSnapshotId: integer (int64)
  Title: Opportunity Stage Snapshot ID

  The unique identifier of the opportunity stage snapshot.
• StgEnterDate: string (date-time)
  Title: Sales Stage Enter Date

  The date when the opportunity entered a sales stage.
• StgExitDate: string (date-time)
  Title: Sales Stage Exit Date

  The date when the opportunity exited a sales stage.
• StgId: integer (int64)
  Title: Sales Stage ID

  The unique identifier of the opportunity sales stage.

{
    "type":"object",
    "properties":{
        "StgExitDate":{
            "title":"Sales Stage Exit Date",
            "type":"string",
            "description":"The date when the opportunity exited a sales stage.",
            "format":"date-time",
            "nullable":true
        },
        "OptyStgSnapshotId":{
            "title":"Opportunity Stage Snapshot ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity stage snapshot.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StgId":{
            "title":"Sales Stage ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity sales stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StgEnterDate":{
            "title":"Sales Stage Enter Date",
            "type":"string",
            "description":"The date when the opportunity entered a sales stage.",
            "format":"date-time",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the opportunity stage snapshot is active.",
            "nullable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : opportunities-OpportunitySubscription-item-post-request

Type: object

Show Source

• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptySubscriptionId: integer (int64)
  Title: Opportunity Subscription ID

  The primary key and the unique internal identifier of the row.
• OptySubscriptionNumber: string
  Title: Opportunity Subscription Number

  Maximum Length: 30

  The unique subscription number to associate a subscription with an opportunity.
• PrimaryFlag: boolean
  Title: Primary

  Indicates whether a subscription is the Primary Subscription associated with the opportunity.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The subscription associated with an opportunity.
• SubscriptionPeriod: string
  Title: Subscription Term

  The duration of the subscription.

{
    "type":"object",
    "properties":{
        "OptySubscriptionId":{
            "title":"Opportunity Subscription ID",
            "type":"integer",
            "description":"The primary key and the unique internal identifier of the row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The subscription associated with an opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether a subscription is the Primary Subscription associated with the opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SubscriptionId"
                ]
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionPeriod":{
            "title":"Subscription Term",
            "type":"string",
            "description":"The duration of the subscription.",
            "nullable":true
        },
        "OptySubscriptionNumber":{
            "title":"Opportunity Subscription Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique subscription number to associate a subscription with an opportunity.",
            "nullable":false
        }
    }
}

Nested Schema : opportunities-OpportunityTeam-item-post-request

Type: object

Show Source

• OptyId: integer (int64)
  The unique identifier of the opportunity.
• ResourceId: integer (int64)
  The unique identifier of the resource.
• TerritoryVersionId: integer (int64)
  The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.

{
    "type":"object",
    "properties":{
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

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

  The unique identifier of the orchestration association.
• OrchestrationAssociationNumber: string
  Title: Orchestration Association Number

  Maximum Length: 64

  The alternate identifier of the orchestration association.
• OrchestrationId(required): integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestration object.
• PerformAction: string
  Title: Action to Perform

  Maximum Length: 30

  The action that user can perform on this orchestration association.
• SourceObjectCode(required): string
  Title: Source Object Code

  Maximum Length: 100

  The language independent object code.
• SourceObjectId(required): 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.

{
    "required":[
        "AssociationStatusCode",
        "OrchestrationId",
        "SourceObjectCode",
        "SourceObjectId"
    ],
    "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/opportunities-OrchestrationAssociations-Steps-item-post-request"
            }
        },
        "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/opportunities-OrchestrationAssociations-ErrorLogs-item-post-request"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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/opportunities-OrchestrationAssociations-Stages-item-post-request"
            }
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":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/opportunities-OrchestrationAssociations-StepsInExecutionPath-item-post-request"
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":false
        },
        "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/opportunities-OrchestrationAssociations-StageObjectives-item-post-request"
            }
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the association.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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/opportunities-OrchestrationAssociations-StepTransitions-item-post-request"
            }
        },
        "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 : 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 opportunities-OrchestrationAssociations-ErrorLogs-item-post-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/opportunities-OrchestrationAssociations-ErrorLogs-item-post-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 opportunities-OrchestrationAssociations-StageObjectives-item-post-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/opportunities-OrchestrationAssociations-StageObjectives-item-post-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 opportunities-OrchestrationAssociations-Stages-item-post-request

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Stages-item-post-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 opportunities-OrchestrationAssociations-Steps-item-post-request

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Steps-item-post-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 opportunities-OrchestrationAssociations-StepsInExecutionPath-item-post-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/opportunities-OrchestrationAssociations-StepsInExecutionPath-item-post-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 opportunities-OrchestrationAssociations-StepTransitions-item-post-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/opportunities-OrchestrationAssociations-StepTransitions-item-post-request"
    }
}

Nested Schema : opportunities-OrchestrationAssociations-ErrorLogs-item-post-request

Type: object

Show Source

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

  The unique identifier of the orchestration stage object.
• 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
        },
        "ErrorLogsId":{
            "title":"Error Logs ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration error logs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":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"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ErrorLogsNumber":{
            "title":"Error Logs Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration error logs.",
            "nullable":false
        },
        "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 : opportunities-OrchestrationAssociations-StageObjectives-item-post-request

Type: object

Show Source

• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stages are to be executed or shown back in UI.
• 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestration stage object.
• OrchestrationStageObjectiveId: integer (int64)
  Title: Stage Objective ID

  The unique 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":{
        "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"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stages are to be executed or shown back in UI.",
            "nullable":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"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stage objective transition.",
            "nullable":true,
            "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"
            }
        },
        "RunTimeStageObjectiveNumber":{
            "title":"Run Time Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage objective object.",
            "nullable":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"
            }
        }
    }
}

Nested Schema : opportunities-OrchestrationAssociations-Stages-item-post-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

  The order in which the stage objectives are to be executed or shown back in UI.
• 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique 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.
• 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
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives are to be executed or 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
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "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"
            }
        },
        "RuntimeStageNumber":{
            "title":"Run Time Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stages runtime object.",
            "nullable":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"
            }
        },
        "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 : opportunities-OrchestrationAssociations-Steps-item-post-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

  The order in which the steps are to be executed or shown back in UI.
• 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

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

  The unique 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":{
        "RunTimeStepNumber":{
            "title":"Run Time Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration steps runtime object.",
            "nullable":false
        },
        "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":"The order in which the steps are to be executed or shown back in UI.",
            "nullable":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"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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 : opportunities-OrchestrationAssociations-StepsInExecutionPath-item-post-request

Type: object

Show Source

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

Nested Schema : opportunities-OrchestrationAssociations-StepTransitions-item-post-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 orchestration step transition runtime email type.
• 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.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestration object.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

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

  The unique identifier of the orchestration step object.
• OrchestrationStepTasksId: integer (int64)
  Title: Orchestration Step Tasks ID

  Unique identifier for the orchestration step tasks.
• 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.
• StepTransitionId: integer (int64)
  Title: Step Transition ID

  The unique identifier of the orchestration step transition object.
• StepTransitionNumber: string
  Title: Step Transition Number

  Maximum Length: 64

  The alternate identifier of the orchestration step transition object.
• StepType: string
  Title: Step Type

  Maximum Length: 30

  The type of the step to which the step transitions correspond to.
• 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 orchestration step transition runtime email type.",
            "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 the step to which the step transitions correspond to.",
            "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
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StepTransitionId":{
            "title":"Step Transition ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step transition object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "OrchestrationStepTasksId":{
            "title":"Orchestration Step Tasks ID",
            "type":"integer",
            "description":"Unique identifier for the orchestration step tasks.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "StepTransitionNumber":{
            "title":"Step Transition Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step transition object.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• DealEstCloseDate: string (date-time)
  Title: Deal Registration Estimated Close Date

  The date when the deal registration is estimated to close.
• DealExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the deal registration will expire.
• DealType: string
  Title: Type

  Maximum Length: 30

  The type of deal registration.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• PartnerCompanyNumber: string
  Title: Partner Company Number

  Maximum Length: 30

  The alternate key identifier of the partner's company.
• PartOrgPartyId: integer (int64)
  Title: Name

  The unique identifier of the partner organization associated with the revenue.
• PartProgramId: integer (int64)
  Title: Program

  The unique identifier of the partner program associated with the revenue.
• PartTypeCd: string
  Title: Type

  Maximum Length: 30

  The code indicating the type of the party associated with the summary or primary revenue of the opportunity. A list of valid values is defined in the lookup PARTNER_PROFILE.
• PartyName: string
  Title: Partner

  Maximum Length: 360

  The name of the partner party associated with the opportunity.
• PartyName1: string
  Title: Primary Resource

  Maximum Length: 360

  The name of the primary partner resource associated with the opportunity.
• PrimaryFlg: string
  Title: Primary

  Indicates whether the Revenue Partner is the primary Revenue Partner for the opportunity.
• PrPartResourcePartyId: integer (int64)
  Title: Primary Resource

  The unique identifier of the primary partner resource.
• RegistrationNumber: string
  Title: Registration Number

  Maximum Length: 120

  The registration number of the deal registration.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 30

  The registration status of the partner who create the opportunity or deal.
• RevnId: integer (int64)
  The unique identifier of the summary or primary revenue for the opportunity.
• RevnPartnerNumber: string
  Title: Opportunity Partner Number

  Maximum Length: 30

  The party number of the partner record.
• RevnPartOrgPartyId: integer (int64)
  The unique identifier of the partner party associated with the opportunity.

{
    "type":"object",
    "properties":{
        "PartTypeCd":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the party associated with the summary or primary revenue of the opportunity. A list of valid values is defined in the lookup PARTNER_PROFILE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"PartyName"
            }
        },
        "DealEstCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration is estimated to close.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "DealType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"30",
            "type":"string",
            "description":"The registration status of the partner who create the opportunity or deal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner party associated with the opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            }
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates whether the Revenue Partner is the primary Revenue Partner for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartOrgPartyId"
                ]
            }
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the deal registration will expire.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "PartyName1":{
            "title":"Primary Resource",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary partner resource associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevnPartnerNumber":{
            "title":"Opportunity Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the partner record.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "PartOrgPartyId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the partner organization associated with the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the summary or primary revenue for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrPartResourcePartyId":{
            "title":"Primary Resource",
            "type":"integer",
            "description":"The unique identifier of the primary partner resource.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "Dependencies":"PartyName"
            }
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The registration number of the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the partner's company.",
            "nullable":false
        },
        "RevnPartOrgPartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner party associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false
        }
    }
}

Nested Schema : opportunities-smartActions-item-post-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(required): 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 if 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 for smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether the smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Indicates whether the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  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.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "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/opportunities-smartActions-UserActionURLBinding-item-post-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if 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/opportunities-smartActions-UserActionNavigation-item-post-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
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false
        },
        "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"
            }
        },
        "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":"Indicates whether the action is seeded or custom.",
            "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/opportunities-smartActions-UserActionRequestPayload-item-post-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 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 for 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 opportunities-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/opportunities-smartActions-UserActionNavigation-item-post-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 opportunities-smartActions-UserActionRequestPayload-item-post-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/opportunities-smartActions-UserActionRequestPayload-item-post-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 opportunities-smartActions-UserActionURLBinding-item-post-request

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

Nested Schema : opportunities-smartActions-UserActionNavigation-item-post-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.
• 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":{
        "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
        },
        "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"
            }
        },
        "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 : opportunities-smartActions-UserActionRequestPayload-item-post-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.
• 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
        },
        "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
        },
        "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"
            }
        },
        "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 : opportunities-smartActions-UserActionURLBinding-item-post-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.
• 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
        },
        "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
        },
        "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"
            }
        },
        "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 : opportunities-winProbabilityDetails-item-post-request

Type: object

Show Source

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

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 : opportunities-item-response

Type: object

Show Source

• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The party number of the sales account that owns the opportunity.
• AiObjectHints: array Object Hints
  Title: Object Hints

  The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.
• Assessments: array Assessments
  Title: Assessments

  The assessments resource is used to view, create, update, and delete the assessment of an opportunity.
• AssetId: integer (int64)
  The unique identifier of the asset associated with the opportunity.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The alternate key identifier of the asset associated with the opportunity.
• AssetProduct: string
  Title: Asset

  The name of the asset product associated with the opportunity.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 100

  The asset serial number associated with the opportunity.
• AssignmentMode: string
  Title: Assignment Mode

  Maximum Length: 30

  Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.
• Attachment: array Opportunity Attachments
  Title: Opportunity Attachments

  The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.
• AverageDaysAtStage: integer (int64)
  Title: Duration

  Read Only: true

  The average duration, in days, the opportunity remains in the current sales stage.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities.
• BdgtAmount: number
  Title: Budget Amount

  The budget amount from the sales account.
• BdgtAmtCurcyCd: string
  Title: Budget Amount Currency

  Maximum Length: 15

  The currency code for budget amount from the sales account.
• BudgetAvailableDate: string (date)
  Title: Date Budget Available

  The date when the budget will be available.
• BudgetedFlag: boolean
  Title: Budgeted

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
• ChampionFlag: boolean
  Title: Key Internal Sponsor

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
• ChildRevenue: array Revenue Items
  Title: Revenue Items

  The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.
• ClosePeriod: string
  Title: Close Period

  Read Only: true

  The names of the filter on which opportunities can be filtered based on effective date range.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the opportunity record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CrmConversionRate: number
  Title: Conversion Rate

  This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.
• CrmCurrencyCode: string
  Title: CRM Common Currency

  Read Only: true

  Maximum Length: 15

  The CRM common currency code.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the opportunity. 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.
• CustomerAccountId: integer (int64)
  Title: Billing Account

  The unique identifier of the customer account associated with the opportunity.
• DealHorizonCode: string
  Title: Estimated Deal Duration

  Maximum Length: 30

  The code indicating the estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DecisionLevelCode: string
  Title: Decision Level

  Maximum Length: 30

  The code indicating the job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the opportunity can be deleted. The default value is true.
• Description: string
  Title: Sales Objective

  Maximum Length: 2000

  The description of the opportunity including the sales objective. The description is added by the Sales Representative.
• DescriptionText: string
  Title: Description

  Read Only: true

  Maximum Length: 255

  The description of the sales objective of the opportunity.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date when the opportunity is expected to close.
• EmailAddress: string
  Title: Owner Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the employee resource that owns the opportunity.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The expected revenue from the opportunity.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• HintCode: string
  Title: Hint Code

  Read Only: true

  Maximum Length: 10

  The AI hint code.
• IBAssetId: integer (int64)
  Title: Installed Base Asset

  The unique identifier of the installed base asset of the opportunity.
• IBAssetNumber: string
  Title: Installed Base Asset Number

  Read Only: true

  Maximum Length: 80

  The asset number of the installed base asset of the opportunity.
• IBAssetSerialNumber: string
  Title: Installed Base Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The associated installed base asset's serial number.
• Interviews: array Interviews
  Title: Interviews

  The interviews resource is used to view the list of interviews related to the opportunities.
• KeyContactId: integer (int64)
  Title: Primary Contact

  The unique identifier of the primary contact of the opportunity.
• 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 opportunity record.
• LastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• LineOfBusinessCode: string
  Title: Line of Business

  Maximum Length: 30

  The line of business that owns the opportunity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCategory: string
  Title: Status Category

  Read Only: true

  Maximum Length: 30

  The status category of the opportunity status.
• ManageGeneralProfileDataFlag: boolean
  Title: Manage General Profile Data

  Read Only: true

  Indicates you can manage general opportunity information such as competitors, lead, source, contacts, references, interactions and assessments.
• ManageRestrictedProfileDataFlag: boolean
  Title: Manage Restricted Profile Data

  Read Only: true

  Indicates you can manage restricted opportunity information such as sales method, sales stage, sales account, primary contact and partners.
• ManageRevenueDataFlag: boolean
  Title: Manage Revenue Data

  Read Only: true

  Indicates you can manage revenue data, such as products and recurring revenue information.
• ManageTeamDataFlag: boolean
  Title: Manage Team Data

  Read Only: true

  Indicates you can manage opportunity sales team data.
• MaximumDaysInStage: integer (int64)
  Title: Stalled Deal Limit

  Read Only: true

  The maximum duration, in days, that an opportunity can be in sales stage before it is considered stalled.
• Name: string
  Title: Name

  Maximum Length: 275

  The name of the opportunity.
• Note: array Notes
  Title: Notes

  The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.
• OpportunityCampaigns: array Opportunity Campaigns
  Title: Opportunity Campaigns

  The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.
• OpportunityCompetitor2: array Opportunity Competitors
  Title: Opportunity Competitors

  The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.
• OpportunityContact: array Opportunity Contacts
  Title: Opportunity Contacts

  The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
• OpportunityDeal: array Opportunity Deals
  Title: Opportunity Deals

  The opportunity deals resource is used to view the deals associated with an opportunity.
• OpportunityLead: array Opportunity Leads
  Title: Opportunity Leads

  The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.
• OpportunityOrigin: string
  Title: Opportunity Origin

  Maximum Length: 30

  Default Value: SALES_OPTY

  The value for the origin of the opportunity.
• OpportunityResource: array Opportunity Team Members
  Title: Opportunity Team Members

  The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.
• OpportunityRollup: array Opportunity Rollups
  Title: Opportunity Rollups

  The opportunity rollups resource is used to view an opportunity rollup.
• OpportunitySource1: array Opportunity Sources
  Title: Opportunity Sources

  The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.
• opportunityStageSnapshots: array Opportunity Stage Snapshots
  Title: Opportunity Stage Snapshots

  The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.
• OpportunitySubscription: array Opportunity Subscriptions
  Title: Opportunity Subscriptions

  The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.
• OpportunityTeam: array Opportunity Teams
  Title: Opportunity Teams

  The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.
• OpportunityTypeCode: string
  Title: Opportunity Type

  Maximum Length: 30

  Display the different types of opportunity such as new, renewal, and expansion.
• OptyCreatedBy: string
  Title: Opportunity Created By

  Maximum Length: 64

  The user who created the opportunity record.
• OptyCreationDate: string (date-time)
  Title: Opportunity Creation Date

  The date when the opportunity was created.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyLastUpdateDate: string (date-time)
  Title: Opportunity Last Updated Date

  The date when the record was last updated.
• OptyLastUpdatedBy: string
  Title: Opportunity Last Updated By

  Maximum Length: 64

  The user who last updated the opportunity record.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OrchestrationAssociations: array Orchestration Associations
  Title: Orchestration Associations

  The orchestrations associations resource is used to view, create, update, and delete an orchestration association.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The party number of a valid employee resource who owns and manages the opportunity.
• OwnerResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of a valid employee resource who owns and manages the opportunity.
• PartyName1: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The name of the opportunity owner.
• PartyUniqueName1: string
  Title: Primary Competitor

  Read Only: true

  Maximum Length: 900

  The unique name of the primary competitor for the opportunity.
• PhaseCd: string
  Title: Phase

  Read Only: true

  Maximum Length: 30

  Default Value: "B - Working the Deal"

  The current phase of the opportunity sales stage.
• PredWinProb: number
  Title: Predicted Win Probability

  Read Only: true

  The AI predicted win probability percent.
• PrimaryCampaignId: integer (int64)
  Title: Primary Campaign ID

  The unique identifier of the primary campaign of the opportunity. It is a reference key to campaign object.
• PrimaryCampaignName: string
  Title: Primary Campaign

  The name of the primary campaign of the opportunity.
• PrimaryCampaignNumber: string
  Title: Primary Campaign Number

  Maximum Length: 30

  The alternate identifier for primary campaign of the opportunity.
• PrimaryCompetitorId: integer (int64)
  Title: Primary Competitor

  The unique identifier of the primary competitor for this opportunity.
• PrimaryCompetitorPartyNumber: string
  Title: Primary Competitor Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the opportunity's primary competitor party.
• PrimaryContactEmailAddress: string
  Title: Primary Contact Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the primary contact for the opportunity. You cannot use e-mail address to query opportunities.
• PrimaryContactEmailPref: string
  Title: Primary Contact Email Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the primary contact has an email preference of do not email, ok to email, or no value.
• PrimaryContactFormattedPhoneNumber: string
  Title: Primary Contact Phone

  Read Only: true

  The formatted phone number of the primary contact for the opportunity.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 360

  The name of the opportunity's primary contact.
• PrimaryContactPartyNumber: string
  Title: Primary Contact Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the opportunity's primary contact party.
• PrimaryContactPhonePref: string
  Title: Primary Contact Phone Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.
• PrimaryOrganizationId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit to which this opportunity belongs.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The alternate key identifier of the opportunity's primary partner company.
• PrimaryPartnerId: integer (int64)
  Title: Primary Partner

  The unique identifier of the primary partner associated with the opportunity.
• PrimaryPartnerOrgPartyName: string
  Title: Primary Partner

  Maximum Length: 360

  The name of the primary partner associated with the opportunity.
• PrimaryRevenueId: integer (int64)
  Title: Summary Revenue Line ID

  The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.
• PrimarySubscriptionId: integer (int64)
  Title: Primary Subscription Id

  The unique identifier of the primary subscription of the opportunity.
• PrimarySubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  Maximum Length: 120

  The alternate identifier of primary subscription of the opportunity.
• PrSrcNumber: string
  Title: Primary Source Number

  Maximum Length: 100

  The alternate key identifier of the primary marketing source or campaign that generated this opportunity.
• QuotaFactor: number
  Title: Quota Factor

  Read Only: true

  The quota factor of the opportunity sales stage.
• QuotedFlag: boolean
  Title: Quoted

  Maximum Length: 1

  Default Value: false

  Indicates whether a quote has been created for this Opportunity.
• RcmndWinProb: number
  Title: Win Probability

  Read Only: true

  Default Value: 0

  The recommended probability of winning the opportunity in the sales stage.
• ReasonWonLostCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The code indicating the reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• RecommendedAction: string
  Title: Recommended Action

  Read Only: true

  Maximum Length: 180

  The AI recommended action.
• RecordSet: string
  Read Only: true

  The name of the predefined opportunity search filters.
• Registered: string
  Title: Registered

  Maximum Length: 30

  Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. The default value is No.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 30

  The registration status of the opportunity or deal created by a partner.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 30

  The registration type used by the partner to create the opportunity or deal.
• RenewalProcess: string
  Title: Renewal Process

  Maximum Length: 30

  The renewal process can be manual, do not renew, or automatic.
• Revenue: number
  Title: Amount

  Default Value: 0

  The estimated revenue amount from the opportunity.
• RevenuePartnerPrimary: array Opportunity Partners
  Title: Opportunity Partners

  The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.
• RiskLevelCode: string
  Title: Level of Risk

  Maximum Length: 30

  The code indicating the risk level of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SalesAccountUniqueName: string
  Title: Customer Account

  Read Only: true

  Maximum Length: 900

  The unique name of the sales account that owns the opportunity.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The code indicating the sales channel for the opportunity. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
• SalesMethod: string
  Title: Sales Method

  Read Only: true

  Maximum Length: 50

  The name of the sales method associated with the opportunity.
• SalesMethodId: integer (int64)
  Title: Sales Method

  The unique identifier of the sales method for this opportunity.
• SalesStage: string
  Title: Sales Stage

  Read Only: true

  Maximum Length: 50

  The current sales stage of the opportunity.
• SalesStageId: integer (int64)
  Title: Sales Stage

  The unique identifier for the sales stage of the opportunity.
• Selected: boolean
  This is used during mass update scenarios from UI.
• SetupRefCode: string
  Maximum Length: 80

  The public unique identifier for the CPQ configuration setup.
• 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.
• SourceType: string
  Title: Source Type

  Read Only: true

  The type of the source object such as Opportunities or Partners as defined in the object metadata.
• StageStatusCd: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: "Open"

  The code indicating the default status for the opportunity's sales stage.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The code indicating the status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• StgOrder: number
  Title: Order

  Read Only: true

  The order of the opportunity's sales stage in the sales method.
• StrategicLevelCode: string
  Title: Strategic Value

  Maximum Length: 30

  The code indicating the strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• TargetPartyId: integer (int64)
  Title: Account

  The unique identifier of the sales account that owns the opportunity.
• TargetPartyName: string
  Title: Account

  Read Only: true

  Maximum Length: 360

  The name of the sales account that owns the opportunity.
• TargetPartyPrimaryAddressCountry: string
  Title: Account Country

  Read Only: true

  Maximum Length: 2

  The country of the primary account's primary address.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the opportunity can be updated. The default value is true.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.
• winProbabilityDetails: array Win Probability Details
  Title: Win Probability Details

  The win probability details resource is used to view the details of the winning probability of an opportunity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QuotaFactor":{
            "title":"Quota Factor",
            "type":"number",
            "description":"The quota factor of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"The AI predicted win probability percent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the opportunity. 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":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OpportunityRollup":{
            "title":"Opportunity Rollups",
            "type":"array",
            "description":"The opportunity rollups resource is used to view an opportunity rollup.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityRollup-item-response"
            },
            "x-cardinality":"1"
        },
        "PrimaryCompetitorId":{
            "title":"Primary Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor for this opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors",
                "dependencies":[
                    "PriCompPartyUniqueName1",
                    "PrimaryCompetitorName"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerId":{
            "title":"Primary Partner",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"The unique identifier of the installed base asset of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "RevenuePartnerPrimary":{
            "title":"Opportunity Partners",
            "type":"array",
            "description":"The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-RevenuePartnerPrimary-item-response"
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the primary contact for the opportunity. You cannot use e-mail address to query opportunities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "RecommendedAction":{
            "title":"Recommended Action",
            "maxLength":"180",
            "type":"string",
            "description":"The AI recommended action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCategory":{
            "title":"Status Category",
            "maxLength":"30",
            "type":"string",
            "description":"The status category of the opportunity status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity's primary partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetPartyId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the sales account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            },
            "x-queryable":true
        },
        "winProbabilityDetails":{
            "title":"Win Probability Details",
            "type":"array",
            "description":"The win probability details resource is used to view the details of the winning probability of an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-winProbabilityDetails-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyCreatedBy":{
            "title":"Opportunity Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrSrcNumber":{
            "title":"Primary Source Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the primary marketing source or campaign that generated this opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "EmailAddress":{
            "title":"Owner Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the employee resource that owns the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OptyCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date when the opportunity was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OptyLastUpdatedBy":{
            "title":"Opportunity Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity's primary contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyContactId":{
            "title":"Primary Contact",
            "type":"integer",
            "description":"The unique identifier of the primary contact of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts",
                "dependencies":[
                    "PriContactPartyNameTransientForLOV",
                    "PriContactPartyName1"
                ]
            },
            "x-queryable":true
        },
        "ManageTeamDataFlag":{
            "title":"Manage Team Data",
            "type":"boolean",
            "description":"Indicates you can manage opportunity sales team data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Note-item-response"
            }
        },
        "Revenue":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated revenue amount from the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber",
                    "AssetProductForExtnLOV"
                ]
            }
        },
        "OpportunityOrigin":{
            "title":"Opportunity Origin",
            "maxLength":"30",
            "type":"string",
            "description":"The value for the origin of the opportunity.",
            "nullable":true,
            "default":"SALES_OPTY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"The associated installed base asset's serial number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetAvailableDate":{
            "title":"Date Budget Available",
            "type":"string",
            "description":"The date when the budget will be available.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Sales Objective",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the opportunity including the sales objective. The description is added by the Sales Representative.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of a valid employee resource who owns and manages the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPartyPrimaryAddressCountry":{
            "title":"Account Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country of the primary account's primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AiObjectHints":{
            "title":"Object Hints",
            "type":"array",
            "description":"The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.",
            "items":{
                "$ref":"#/components/schemas/opportunities-AiObjectHints-item-response"
            }
        },
        "AverageDaysAtStage":{
            "title":"Duration",
            "type":"integer",
            "description":"The average duration, in days, the opportunity remains in the current sales stage.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "OpportunityTypeCode":{
            "title":"Opportunity Type",
            "maxLength":"30",
            "type":"string",
            "description":"Display the different types of opportunity such as new, renewal, and expansion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StgOrder":{
            "title":"Order",
            "type":"number",
            "description":"The order of the opportunity's sales stage in the sales method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the sales account that owns the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StageStatusCd":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the default status for the opportunity's sales stage.",
            "nullable":true,
            "readOnly":true,
            "default":"\"Open\"",
            "x-queryable":false
        },
        "DealHorizonCode":{
            "title":"Estimated Deal Duration",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "DecisionLevelCode":{
            "title":"Decision Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "BdgtAmtCurcyCd":{
            "title":"Budget Amount Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity's primary competitor party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign of the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            },
            "x-queryable":true
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "Selected":{
            "type":"boolean",
            "description":"This is used during mass update scenarios from UI.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetProduct":{
            "title":"Asset",
            "type":"string",
            "description":"The name of the asset product associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "IBAssetNumber":{
            "title":"Installed Base Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"The asset number of the installed base asset of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign of the opportunity. 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 the list of interviews related to the opportunities.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Interviews-item-response"
            }
        },
        "QuotedFlag":{
            "title":"Quoted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a quote has been created for this Opportunity.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OpportunitySource1":{
            "title":"Opportunity Sources",
            "type":"array",
            "description":"The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunitySource1-item-response"
            }
        },
        "RcmndWinProb":{
            "title":"Win Probability",
            "type":"number",
            "description":"The recommended probability of winning the opportunity in the sales stage.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"30",
            "type":"string",
            "description":"The registration status of the opportunity or deal created by a partner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ManageRevenueDataFlag":{
            "title":"Manage Revenue Data",
            "type":"boolean",
            "description":"Indicates you can manage revenue data, such as products and recurring revenue information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CrmConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.",
            "nullable":true,
            "x-queryable":true
        },
        "ManageGeneralProfileDataFlag":{
            "title":"Manage General Profile Data",
            "type":"boolean",
            "description":"Indicates you can manage general opportunity information such as competitors, lead, source, contacts, references, interactions and assessments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":"50",
            "type":"string",
            "description":"The code indicating the sales channel for the opportunity. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the sales objective of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ChampionFlag":{
            "title":"Key Internal Sponsor",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ClosePeriod":{
            "title":"Close Period",
            "type":"string",
            "description":"The names of the filter on which opportunities can be filtered based on effective date range.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DefaultQueryValue":"CURR_QTR",
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist"
            },
            "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
        },
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method for this opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "type":"string",
            "description":"The type of the source object such as Opportunities or Partners as defined in the object metadata.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for primary campaign of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Attachment":{
            "title":"Opportunity Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Attachment-item-response"
            }
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The expected revenue from the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "OpportunityContact":{
            "title":"Opportunity Contacts",
            "type":"array",
            "description":"The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityContact-item-response"
            }
        },
        "PartyName1":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the opportunity owner.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist",
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"275",
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "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/opportunities-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/opportunities-smartActions-item-response"
            }
        },
        "PrimaryContactFormattedPhoneNumber":{
            "title":"Primary Contact Phone",
            "type":"string",
            "description":"The formatted phone number of the primary contact for the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "RiskLevelCode":{
            "title":"Level of Risk",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the risk level of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "type":"string",
            "description":"The name of the predefined opportunity search filters.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "AssignmentMode":{
            "title":"Assignment Mode",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "OpportunityCompetitor2":{
            "title":"Opportunity Competitors",
            "type":"array",
            "description":"The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityCompetitor2-item-response"
            }
        },
        "ChildRevenue":{
            "title":"Revenue Items",
            "type":"array",
            "description":"The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-item-response"
            }
        },
        "SalesAccountUniqueName":{
            "title":"Customer Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the sales account that owns the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "MaximumDaysInStage":{
            "title":"Stalled Deal Limit",
            "type":"integer",
            "description":"The maximum duration, in days, that an opportunity can be in sales stage before it is considered stalled.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "ReasonWonLostCode":{
            "title":"Win/Loss Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "SalesMethod":{
            "title":"Sales Method",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the sales method associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "opportunityStageSnapshots":{
            "title":"Opportunity Stage Snapshots",
            "type":"array",
            "description":"The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-opportunityStageSnapshots-item-response"
            }
        },
        "SalesStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier for the sales stage of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"18",
                "Dependencies":"SalesMethodId,PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "Assessments":{
            "title":"Assessments",
            "type":"array",
            "description":"The assessments resource is used to view, create, update, and delete the assessment of an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-item-response"
            }
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"5"
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":"100",
            "type":"string",
            "description":"The asset serial number associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BdgtAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"The budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetPartyName":{
            "title":"Account",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the sales account that owns the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OpportunityResource":{
            "title":"Opportunity Team Members",
            "type":"array",
            "description":"The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityResource-item-response"
            }
        },
        "PrimaryPartnerOrgPartyName":{
            "title":"Primary Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary partner associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SetupRefCode":{
            "maxLength":"80",
            "type":"string",
            "description":"The public unique identifier for the CPQ configuration setup.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityLead":{
            "title":"Opportunity Leads",
            "type":"array",
            "description":"The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityLead-item-response"
            }
        },
        "PrimarySubscriptionId":{
            "title":"Primary Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the primary subscription of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "HintCode":{
            "title":"Hint Code",
            "maxLength":"10",
            "type":"string",
            "description":"The AI hint code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OpportunitySubscription":{
            "title":"Opportunity Subscriptions",
            "type":"array",
            "description":"The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunitySubscription-item-response"
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the opportunity's primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPhonePref":{
            "title":"Primary Contact Phone Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the primary 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":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "CrmCurrencyCode":{
            "title":"CRM Common Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The CRM common currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":"30",
            "type":"string",
            "description":"The renewal process can be manual, do not renew, or automatic.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the customer account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "OpportunityDeal":{
            "title":"Opportunity Deals",
            "type":"array",
            "description":"The opportunity deals resource is used to view the deals associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityDeal-item-response"
            }
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"The registration type used by the partner to create the opportunity or deal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryOrganizationId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit to which this opportunity belongs.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            }
        },
        "StrategicLevelCode":{
            "title":"Strategic Value",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "PartyUniqueName1":{
            "title":"Primary Competitor",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the primary competitor for the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OpportunityTeam":{
            "title":"Opportunity Teams",
            "type":"array",
            "description":"The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityTeam-item-response"
            }
        },
        "BudgetedFlag":{
            "title":"Budgeted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesStage":{
            "title":"Sales Stage",
            "maxLength":"50",
            "type":"string",
            "description":"The current sales stage of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PhaseCd":{
            "title":"Phase",
            "maxLength":"30",
            "type":"string",
            "description":"The current phase of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "default":"\"B - Working the Deal\"",
            "x-queryable":false
        },
        "ManageRestrictedProfileDataFlag":{
            "title":"Manage Restricted Profile Data",
            "type":"boolean",
            "description":"Indicates you can manage restricted opportunity information such as sales method, sales stage, sales account, primary contact and partners.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PrimarySubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The alternate identifier of primary subscription of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OpportunityCampaigns":{
            "title":"Opportunity Campaigns",
            "type":"array",
            "description":"The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityCampaigns-item-response"
            }
        },
        "LineOfBusinessCode":{
            "title":"Line of Business",
            "maxLength":"30",
            "type":"string",
            "description":"The line of business that owns the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryContactEmailPref":{
            "title":"Primary Contact Email Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the primary 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":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "PrimaryRevenueId":{
            "title":"Summary Revenue Line ID",
            "type":"integer",
            "description":"The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Registered":{
            "title":"Registered",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No. The default value is No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the opportunity is expected to close.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            },
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":"30",
            "type":"string",
            "description":"This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Object Hints

Type: array

Title: Object Hints

The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.

Show Source

• Array of: object opportunities-AiObjectHints-item-response

{
    "title":"Object Hints",
    "type":"array",
    "description":"The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.",
    "items":{
        "$ref":"#/components/schemas/opportunities-AiObjectHints-item-response"
    }
}

Nested Schema : Assessments

Type: array

Title: Assessments

The assessments resource is used to view, create, update, and delete the assessment of an opportunity.

Show Source

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

{
    "title":"Assessments",
    "type":"array",
    "description":"The assessments resource is used to view, create, update, and delete the assessment of an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Assessments-item-response"
    }
}

Nested Schema : Opportunity Attachments

Type: array

Title: Opportunity Attachments

The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.

Show Source

• Array of: object opportunities-Attachment-item-response

{
    "title":"Opportunity Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Attachment-item-response"
    }
}

Nested Schema : Revenue Items

Type: array

Title: Revenue Items

The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.

Show Source

• Array of: object opportunities-ChildRevenue-item-response

{
    "title":"Revenue Items",
    "type":"array",
    "description":"The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-item-response"
    }
}

Nested Schema : Interviews

Type: array

Title: Interviews

The interviews resource is used to view the list of interviews related to the opportunities.

Show Source

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

{
    "title":"Interviews",
    "type":"array",
    "description":"The interviews resource is used to view the list of interviews related to the opportunities.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Interviews-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 : Notes

Type: array

Title: Notes

The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.

Show Source

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

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-Note-item-response"
    }
}

Nested Schema : Opportunity Campaigns

Type: array

Title: Opportunity Campaigns

The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityCampaigns-item-response

{
    "title":"Opportunity Campaigns",
    "type":"array",
    "description":"The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityCampaigns-item-response"
    }
}

Nested Schema : Opportunity Competitors

Type: array

Title: Opportunity Competitors

The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.

Show Source

• Array of: object opportunities-OpportunityCompetitor2-item-response

{
    "title":"Opportunity Competitors",
    "type":"array",
    "description":"The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityCompetitor2-item-response"
    }
}

Nested Schema : Opportunity Contacts

Type: array

Title: Opportunity Contacts

The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.

Show Source

• Array of: object opportunities-OpportunityContact-item-response

{
    "title":"Opportunity Contacts",
    "type":"array",
    "description":"The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityContact-item-response"
    }
}

Nested Schema : Opportunity Deals

Type: array

Title: Opportunity Deals

The opportunity deals resource is used to view the deals associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityDeal-item-response

{
    "title":"Opportunity Deals",
    "type":"array",
    "description":"The opportunity deals resource is used to view the deals associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityDeal-item-response"
    }
}

Nested Schema : Opportunity Leads

Type: array

Title: Opportunity Leads

The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.

Show Source

• Array of: object opportunities-OpportunityLead-item-response

{
    "title":"Opportunity Leads",
    "type":"array",
    "description":"The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityLead-item-response"
    }
}

Nested Schema : Opportunity Team Members

Type: array

Title: Opportunity Team Members

The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityResource-item-response

{
    "title":"Opportunity Team Members",
    "type":"array",
    "description":"The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityResource-item-response"
    }
}

Nested Schema : Opportunity Rollups

Type: array

Title: Opportunity Rollups

The opportunity rollups resource is used to view an opportunity rollup.

Show Source

• Array of: object opportunities-OpportunityRollup-item-response

{
    "title":"Opportunity Rollups",
    "type":"array",
    "description":"The opportunity rollups resource is used to view an opportunity rollup.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityRollup-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Opportunity Sources

Type: array

Title: Opportunity Sources

The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.

Show Source

• Array of: object opportunities-OpportunitySource1-item-response

{
    "title":"Opportunity Sources",
    "type":"array",
    "description":"The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunitySource1-item-response"
    }
}

Nested Schema : Opportunity Stage Snapshots

Type: array

Title: Opportunity Stage Snapshots

The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.

Show Source

• Array of: object opportunities-opportunityStageSnapshots-item-response

{
    "title":"Opportunity Stage Snapshots",
    "type":"array",
    "description":"The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-opportunityStageSnapshots-item-response"
    }
}

Nested Schema : Opportunity Subscriptions

Type: array

Title: Opportunity Subscriptions

The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.

Show Source

• Array of: object opportunities-OpportunitySubscription-item-response

{
    "title":"Opportunity Subscriptions",
    "type":"array",
    "description":"The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunitySubscription-item-response"
    }
}

Nested Schema : Opportunity Teams

Type: array

Title: Opportunity Teams

The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.

Show Source

• Array of: object opportunities-OpportunityTeam-item-response

{
    "title":"Opportunity Teams",
    "type":"array",
    "description":"The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityTeam-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 opportunities-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/opportunities-OrchestrationAssociations-item-response"
    }
}

Nested Schema : Opportunity Partners

Type: array

Title: Opportunity Partners

The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.

Show Source

• Array of: object opportunities-RevenuePartnerPrimary-item-response

{
    "title":"Opportunity Partners",
    "type":"array",
    "description":"The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-RevenuePartnerPrimary-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 opportunities-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/opportunities-smartActions-item-response"
    }
}

Nested Schema : Win Probability Details

Type: array

Title: Win Probability Details

The win probability details resource is used to view the details of the winning probability of an opportunity.

Show Source

• Array of: object opportunities-winProbabilityDetails-item-response

{
    "title":"Win Probability Details",
    "type":"array",
    "description":"The win probability details resource is used to view the details of the winning probability of an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-winProbabilityDetails-item-response"
    }
}

Nested Schema : opportunities-AiObjectHints-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.
• EnabledFlag: boolean
  Title: Enabled

  Read Only: true

  Maximum Length: 1

  Indicates whether the record is enabled or not. Y or null for enabled and N for disabled.
• EndDate: string (date-time)
  Title: End Date

  The date when the hint ends.
• Explanations: string (byte)
  The explanatory text for the reasoning behind predictions from the AI models.
• HintCode: string
  Title: Hint Code

  Maximum Length: 10

  The unique identifier of the hint.
• HintType: string
  Title: Hint Type

  Read Only: true

  Maximum Length: 30

  The record type. For example, RECOMMENDATION, WIN_PROB, etc.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocalizedDetail: string
  Title: Explanation

  Read Only: true

  Maximum Length: 255

  The translated explanation and details for the hint.
• LocalizedSummary: string
  Title: Action

  Read Only: true

  Maximum Length: 180

  The translated short summary of the hint.
• ObjectHintId: integer (int64)
  Title: Object Hint ID

  The unique identifier of the object hint.
• ObjectInstanceId: integer (int64)
  Title: Object ID

  The unique identifier of the object specified by OBJECT_TYPE column.
• ObjectType: string
  Title: Object Type

  Maximum Length: 30

  The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc.
• ObjectUuid: string
  Title: Object Unique ID

  Maximum Length: 50

  The unique identifier of the object which is an alternate key.
• PredWinProb: number
  Title: Predicted Win Probability

  The win probability predicted by the AI engine.
• RespResourceId: integer (int64)
  Title: Response Resource ID

  The resource ID of the user who provided feedback on the recommendation.
• StartDate: string (date-time)
  The date when the hint starts.
• TaskId: integer (int64)
  The unique identifier of the task that was created for the recommendation.
• TopHintFlag: boolean
  Maximum Length: 1

  Indicates the current highest ranked recommendation to display in the UI.
• UserResponse: string
  Title: User Response

  Maximum Length: 1

  The user's response to a recommendation.

{
    "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
        },
        "HintType":{
            "title":"Hint Type",
            "maxLength":"30",
            "type":"string",
            "description":"The record type. For example, RECOMMENDATION, WIN_PROB, etc.",
            "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
        },
        "TaskId":{
            "type":"integer",
            "description":"The unique identifier of the task that was created for the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocalizedSummary":{
            "title":"Action",
            "maxLength":"180",
            "type":"string",
            "description":"The translated short summary of the hint.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectHintId":{
            "title":"Object Hint ID",
            "type":"integer",
            "description":"The unique identifier of the object hint.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TopHintFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the current highest ranked recommendation to display in the UI.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the hint ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RespResourceId":{
            "title":"Response Resource ID",
            "type":"integer",
            "description":"The resource ID of the user who provided feedback on the recommendation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HintCode":{
            "title":"Hint Code",
            "maxLength":"10",
            "type":"string",
            "description":"The unique identifier of the hint.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the hint starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"The win probability predicted by the AI engine.",
            "nullable":true,
            "x-queryable":true
        },
        "UserResponse":{
            "title":"User Response",
            "maxLength":"1",
            "type":"string",
            "description":"The user's response to a recommendation.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The object for which hint is applicable for example, OPPORTUNITY, LEAD, etc.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectUuid":{
            "title":"Object Unique ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the object which is an alternate key.",
            "nullable":false,
            "x-queryable":true
        },
        "Explanations":{
            "type":"string",
            "description":"The explanatory text for the reasoning behind predictions from the AI models.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LocalizedDetail":{
            "title":"Explanation",
            "maxLength":"255",
            "type":"string",
            "description":"The translated explanation and details for the hint.",
            "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"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record is enabled or not. Y or null for enabled and N for disabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectInstanceId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object specified by OBJECT_TYPE column.",
            "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
        },
        "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 : 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 : opportunities-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 and update the question groups in an assessment.
• AssessedLanguage: string
  Title: Assessment Language

  Maximum Length: 4

  Default Value: US

  The language of the assessment.
• AssessedObjectId: integer (int64)
  Title: Assessed Object ID

  The unique identifier of the assessed business object.
• AssessedObjTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  The code indicating the type of the assessed business object.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of an assessment.
• AssessmentScore: integer (int64)
  Title: Score

  Default Value: 0

  The calculated score of assessment.
• AssessTemplateId: integer (int64)
  Title: Template Name

  The unique identifier of the assessment template that served as the source of this assessment.
• BusinessUnit: integer (int64)
  Title: Business Unit

  The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the assessment record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the assessment record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the assessment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 255

  The name of the assessment.
• RatingFeedback: string
  Title: Feedback

  Read Only: true

  The feedback mapped to the rating.
• RatingTerm: string
  Title: Rating

  Read Only: true

  The overall rating of the assessment as configured in the associated assessment template.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: INCOMPLETE

  The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE.
• StatusFuse: string
  Title: Status

  Read Only: true

  The status of the assessment.
• TemplateName: string
  Title: Template

  The name of the assessment template.
• TemplateType: string
  Title: Template Type

  The type of the assessment template associated with the assessment.
• TotalAnswered: number
  Title: Total Questions Answered

  The number of questions answered in the assessment.
• TotalQuestions: number
  Title: Total Questions

  The total number of questions to be answered in the assessment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the assessment 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 assessment.",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the assessment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedObjTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the assessed business object.",
            "nullable":false,
            "x-queryable":true
        },
        "AssessedLanguage":{
            "title":"Assessment Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language of the assessment.",
            "nullable":false,
            "default":"US",
            "x-queryable":true
        },
        "TotalQuestions":{
            "title":"Total Questions",
            "type":"number",
            "description":"The total number of questions to be answered in the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateType":{
            "title":"Template Type",
            "type":"string",
            "description":"The type of the assessment template associated with the assessment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessmentScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated score of assessment.",
            "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 of the assessment. 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 answered in the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessAnswerGroups":{
            "title":"Assessment Answer Groups",
            "type":"array",
            "description":"The assessment answer groups resource is used to view and update the question groups in an assessment.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-item-response"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "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 assessment.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of an assessment.",
            "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 assessment 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 assessment as configured in the associated assessment template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssessTemplateId":{
            "title":"Template Name",
            "type":"integer",
            "description":"The unique identifier of the assessment template that served as the source of this assessment.",
            "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 assessment 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 and update the question groups in an assessment.

Show Source

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

{
    "title":"Assessment Answer Groups",
    "type":"array",
    "description":"The assessment answer groups resource is used to view and update the question groups in an assessment.",
    "items":{
        "$ref":"#/components/schemas/opportunities-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 : opportunities-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 answers resource is used to view and update a response to a question in the question group.
• AssessmentId: integer (int64)
  The unique identifier of the assessment associated with answer group.
• AttributeGroupId: integer (int64)
  The unique identifier of the question group of the associated template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  The name of the answer group.

{
    "type":"object",
    "properties":{
        "AttributeGroupId":{
            "type":"integer",
            "description":"The unique identifier of the question group of the associated 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 assessment 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 answers resource is used to view and update a response to a question in the question group.",
            "items":{
                "$ref":"#/components/schemas/opportunities-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response"
            }
        }
    }
}

Nested Schema : Assessment Answers

Type: array

Title: Assessment Answers

The assessment answers resource is used to view and update a response to a question in the question group.

Show Source

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

{
    "title":"Assessment Answers",
    "type":"array",
    "description":"The assessment answers resource is used to view and update a response to a question in the question group.",
    "items":{
        "$ref":"#/components/schemas/opportunities-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 : opportunities-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 assessment answer.
• AssessmentId: integer (int64)
  The unique identifier of the assessments associated with answer.
• AttributeGroupId: integer (int64)
  Title: Question Group

  The unique identifier of the question group associated with assessment answer.
• AttributeId: integer (int64)
  Title: Question

  The unique identifier of the question associated with assessment answer.
• AttributeName: string
  Read Only: true

  Maximum Length: 500

  The name of the question.
• AttributeValueId: integer (int64)
  Title: Response

  The unique identifier of the response.
• Comments: string
  Title: Comments

  Maximum Length: 1500

  The assessment runtime comments entered by end user.
• HasComments: string
  Indicates if the comments are present or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseValue: string
  Title: Response

  Read Only: true

  The response to the question.

{
    "type":"object",
    "properties":{
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the assessments 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 assessment answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1500",
            "type":"string",
            "description":"The assessment runtime comments entered by end user.",
            "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 assessment 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 to 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 assessment 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 : opportunities-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The login of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of the data.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The login of the user who last updated the attachment.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment 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 the 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 the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "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 attachment.",
            "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 login of the user who created the attachment.",
            "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 length 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 current version number of the attachment.",
            "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 associated with 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 attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the data.",
            "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 login of the user who last updated the attachment.",
            "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 of the 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 URL of the attachment.",
            "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. The default value is false.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of 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":"The unique identifier used for tracking the uploaded 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 : opportunities-ChildRevenue-item-response

Type: object

Show Source

• ActualCloseDate: string (date)
  Title: Actual Close Date

  The date when the revenue line was closed.
• AmountAggregatedForScheduleFlag: boolean
  Title: Divide Amount by Transactions

  Maximum Length: 1

  The amounts are divided by the number of transactions based on the set schedule.
• BUOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the Business Unit that owns the opportunity.
• CalculatedLineRevnAmtInCorpCur: number
  Title: Revenue in Corporate Currency

  Read Only: true

  The calculated revenue amount in corporate currency.
• ChildSplitRevenue: array Child Split Revenues
  Title: Child Split Revenues

  The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.
• CloseReasonCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The code indicating the reason for winning or losing the revenue. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON.
• Comments: string
  Title: Line Comments

  Maximum Length: 250

  The user-provided comments for the revenue line.
• CommitFlag: boolean
  Title: Forecast

  Maximum Length: 1

  Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.
• CompetitorPartyName: string
  Title: Competitor Party Name

  Read Only: true

  Maximum Length: 360

  The party name of the primary competitor of this child revenue.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContractEndDate: string (date-time)
  Title: Contract End Date

  The end date of the contract for the quote.
• ContractStartDate: string (date-time)
  Title: Contract Start Date

  The start date of the contract for the quote.
• ConversionRate: number
  Title: Conversion Rate

  The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
• ConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
• CostAmount: number
  Title: Cost

  Default Value: 0

  The cost amount for the opportunity.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the child revenue record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CreditRcptPartOrgPartyId: integer (int64)
  Title: Credit Recipient Partner

  The unique identifier of the credit recipient partner organization party.
• CrmConversionRate: number
  Title: CRM Conversion Rate

  The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
• CrmConversionRateType: string
  Title: CRM Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
• CrmCurcyCode: string
  Title: Currency

  Maximum Length: 15

  The common CRM currency code.
• CurrStgId: integer (int64)
  Title: Sales Stage

  Read Only: true

  The sales stage identifier of this revenue line.
• CustomerAccountId: integer (int64)
  Title: Revenue Customer Account ID

  The unique identifier of the customer account that owns the opportunity.
• CustomerRegistryId: string
  Title: Account Registry ID

  Read Only: true

  Maximum Length: 30

  The name of the opportunity account registry ID.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the opportunity revenue can be deleted. The default value is true.
• Description: string
  Title: Product

  Maximum Length: 240

  The user-provided description of the product associated with the revenue.
• Discount: number
  Title: Discount

  The discount percent.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date when the child revenue closes. The default value is the opportunity's close date.
• EffectiveEndDate: string (date)
  Read Only: true

  The end date for the territory owner.
• EffectiveStartDate: string (date)
  Read Only: true

  The start date for the territory owner.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• ExpectDlvryDate: string (date)
  Title: Expected Delivery Date

  The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.
• ExternalAssetKey: string
  Title: External Asset Key

  Maximum Length: 255

  The asset key from an external system.
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 255

  The root asset key of the parent from an external system.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 255

  The root asset key obtained from an external system.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• InventoryItemId: integer (int64)
  Title: Product

  The unique identifier of the product in the inventory.
• InventoryOrgId: integer (int64)
  Title: Product

  The unique identifier of the organization in the inventory.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The alternate key identifier of the product that is associated with the revenue.
• ItemNumberInternal: string
  Title: Item Number Internal

  Maximum Length: 300

  The unique internal identifier of the product that is associated with the revenue.
• LastUpdateDate: string (date-time)
  Title: Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: 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.
• MarginAmount: number
  Title: Margin

  Default Value: 0

  The margin amount for the opportunity.
• MonthlyRecurringRevenue: number
  Title: Monthly Recurring Revenue

  The monthly recurring revenue on the revenue line.
• MonthlyUsageRevenue: number
  Title: Monthly Usage Revenue

  The monthly usage revenue on the revenue line.
• Name1: string
  Title: Forecast Territory

  Read Only: true

  Maximum Length: 60

  The name of the territory.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The non recurring revenue amount associated with the revenue line.
• NqSplitAllocTypeCode: string
  Title: Allocation Style

  Maximum Length: 30

  The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
• OpportunityCreationDate: string (date-time)
  Title: Opportunity Creation Date

  Read Only: true

  The date and time when the opportunity was created.
• OpportunityCurrencyCode: string
  Title: Opportunity Currency

  Read Only: true

  Maximum Length: 15

  The currency code associated with the opportunity. 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.
• OpportunityOwnerPartyName: string
  Title: Opportunity Owner

  Read Only: true

  Maximum Length: 360

  The name of the opportunity owner.
• OpportunityOwnerResourcePartyId: integer (int64)
  Title: Owner

  Read Only: true

  The unique identifier of a valid employee resource who owns and manages the opportunity.
• OpportunityPrSrcNumber: string
  Title: Primary Source

  Read Only: true

  Maximum Length: 100

  The alternate key identifier of the primary marketing source or campaign that generated this opportunity.
• OptyEffectiveDate: string (date)
  Title: Opportunity Close Date

  Read Only: true

  The date when the opportunity is expected to close.
• OptyId: integer (int64)
  Title: Revenue Opportunity ID

  The unique identified of the opportunity.
• OptyLastUpdateDate: string (date-time)
  Title: Opportunity Last Update Date

  Read Only: true

  The date when the opportunity record was last updated.
• OptyLeadId: integer (int64)
  Title: Opportunity Lead

  The unique Identifier of the lead associated with opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity associated to child revenue.
• OrganizationId: integer (int64)
  Title: Organization

  The unique identifier of the organization to which the product belongs.
• OwnerDealExpirationDate: string (date)
  Title: Effective End Date

  The date when the owner deal expires.
• OwnerDealProtectedDate: string (date)
  Title: Effective Start Date

  The date when the owner deal starts.
• OwnerLockAsgnFlag: boolean
  Title: Lock Credit Owner

  Maximum Length: 1

  Default Value: false

  Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked. The default value is N.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The party number for the owner of child revenue.
• ParentRevnId: integer (int64)
  Title: Parent Revenue ID

  The unique identifier of the parent revenue line, used for Lineset functionality.
• PartEngagementTypeCd: string
  Title: Lead Registration Type

  Maximum Length: 100

  The code indicating the type of partner engagement.
• PartOrgPartyId: integer (int64)
  Title: Partner Organization Party ID

  Read Only: true

  The unique identifier of the primary revenue partner party.
• PartOrgPartyName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the primary partner associated with the child revenue.
• PartyName2: string
  Title: Sales Credit Recipient

  Read Only: true

  Maximum Length: 360

  The name of this sales credit recipient.
• PrCmptPartyId: integer (int64)
  Title: Competitor

  The unique identifier of the primary competitor of this child revenue.
• PriceTypeCode: string
  Title: Price Type

  Maximum Length: 30

  The code indicating the type of pricing associated with the revenue line. The list of valid values are Mixed, Usage, Recurring, and One Time.
• PrimaryCompetitorPartyNumber: string
  Title: Primary Competitor Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the primary competitor of this child revenue.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact Party ID

  Read Only: true

  The unique identifier of the primary contact of this child revenue.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 360

  The name of the primary contact of this child revenue.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.
• PrimaryOrganizationName: string
  Read Only: true

  The name of the business unit to which this revenue line belongs.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The alternate key identifier of the revenue's primary partner company.
• ProdGroupId: integer (int64)
  Title: Product Group

  The unique identifier of the product group.
• ProdGroupModelConfigAttributes: string
  Title: Product Group Model Attributes

  Read Only: true

  Maximum Length: 4000

  The model configuration attributes associated with the product group in revenue line.
• ProdGroupModelFamily: string
  Title: Product Group Model Family

  Read Only: true

  Maximum Length: 1000

  The model family associated with the product group.
• ProdGroupModelLine: string
  Title: Product Group Model Line

  Read Only: true

  Maximum Length: 1000

  The model line associated with the product group.
• ProdGroupModelName: string
  Title: Product Group Model

  Read Only: true

  Maximum Length: 1000

  The model name associated with the product group in revenue line.
• ProdGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group associated with the revenue.
• ProdGroupQuotableFlag: boolean
  Title: Quotable

  Read Only: true

  Maximum Length: 1

  Indicates whether a product group is quotable.
• ProductConfigurableFlag: boolean
  Title: Configurable Product

  Read Only: true

  Maximum Length: 1

  Indicates whether a product allows configuration.
• ProductGroupReferenceNumber: string
  Title: Product Group Reference Number

  Maximum Length: 50

  The reference number of the product group.
• productGroups: array Product Groups
  Title: Product Groups

  The product group resource is used to view the product groups associated with an opportunity. 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.
• ProductModelConfigAttributes: string
  Title: Product Model Attributes

  Read Only: true

  Maximum Length: 4000

  The model configuration attributes associated with the product in revenue line.
• ProductModelFamily: string
  Title: Product Model Family

  Read Only: true

  Maximum Length: 1000

  The model family associated with the product.
• ProductModelLine: string
  Title: Product Model Line

  Read Only: true

  Maximum Length: 1000

  The model line associated with the product.
• ProductModelName: string
  Title: Product Model

  Read Only: true

  Maximum Length: 1000

  The model name associated with the product in revenue line.
• products: array Products
  Title: Products

  The products resource is used to view the products associated with an opportunity.
• ProductType: string
  Title: Product Type

  The type of product on the revenue line, such as item or product group.
• PrPartOrgPartyId: integer (int64)
  Title: Partner

  The unique identifier of the primary revenue partner organization party.
• PrTerritoryVersionId: integer (int64)
  Title: Forecast Territory

  The unique identifier of the primary territory for this revenue item.
• PrTerritoryVersionIdForManual: string
  Title: Manually Assigned Territory Version ID

  The version ID of a territory that is to be manually assigned to the revenue record.
• Quantity: number
  Title: Quantity

  The quantity of product for this opportunity.
• RecordSet: string
  Title: Record Set

  Read Only: true

  The name of the predefined opportunity search filters.
• RecurDownsideAmount: number
  Title: Recurring Worst Case

  The minimum revenue amount from the recurrence.
• RecurEndDate: string (date)
  Title: End By

  The date when the child revenue recurrence ends.
• RecurFrequencyCode: string
  Title: Frequency

  Maximum Length: 30

  The code that indicates the frequency of recurrence for the child revenue. A list of valid values is defined in the lookup MOO_RECURRING_FREQUENCY.
• RecurNumberPeriods: integer (int64)
  Title: End After

  The number of times the child revenue should recur.
• RecurParentRevnId: integer (int64)
  Title: Recurring Revenue Parent ID

  The unique identifier for the parent revenue of the recurring revenue lines.
• RecurPeriodOrEndDateCode: string
  Title: Recurrence Period or End Date Code

  Default Value: EndAfter

  The code that indicates if a date or the number of recurrences are specified to end the recurrences.
• RecurQuantity: number
  Title: Recurring Quantity

  The quantity of the child revenue recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line.
• RecurRevnAmount: number
  Title: Scheduled Revenue Amount

  The amount of revenue from the child revenue recurrence.
• RecurringRevenue: array Recurring Revenues
  Title: Recurring Revenues

  The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.
• RecurStartDate: string (date)
  Title: Start Date

  The date when the recurrence starts.
• RecurTypeCode: string
  Title: Recurrence Type Code

  Maximum Length: 30

  The code indicating if the line is a standard revenue line or a recurring revenue line. A list of valid values is defined in the lookup MOO_REVN_RECUR_TYPE.
• RecurUnitPrice: number
  Title: Recurring Estimated Price

  The price of each child revenue recurrence.
• RecurUpsideAmount: number
  Title: Recurring Best Case

  The maximum revenue amount from the recurrence.
• ResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of the revenue owner.
• RevenueTerritory: array Opportunity Revenue Territories
  Title: Opportunity Revenue Territories

  The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
• RevenueTypeCategory: string
  Title: Revenue Type Category

  Maximum Length: 30

  The revenue category type on the opportunity revenue line.
• RevnAmount: number
  Title: Amount

  Default Value: 0

  The amount of revenue that is earned from this opportunity.
• RevnAmountCurcyCode: string
  Title: Line Currency

  Maximum Length: 15

  The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• RevnCategoryCode: string
  Title: Revenue Category

  Maximum Length: 30

  The code indicating the revenue category used in Revenue Line Set functionality. A list of valid values is defined in the lookup MOO_REVN_CATEGORY.
• RevnCreationDate: string (date-time)
  Title: Creation Date

  The date when the revenue item was created.
• RevnId: integer (int64)
  Title: Revenue ID

  The unique identifier of the revenue for the opportunity.
• RevnLastUpdateDate: string (date-time)
  Title: Update Date

  The date and time when the revenue record was last updated.
• RevnLineTypeCode: string
  Title: Revenue Line Type Code

  Maximum Length: 30

  The code indicating the type of revenue line, such as Opportunity Summary Revenue, Standard Revenue, and so on. A list of valid values is defined in the lookup MOO_REVN_LINE_TYPE.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
• RevnSequenceNumber: integer (int32)
  Title: Line Set

  The revenue sequence number.
• SalesAccountId: integer (int64)
  Title: Account

  The unique identifier of the opportunity sales account.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.
• SalesCreditTypeCode: string
  Title: Sales Credit Type

  Maximum Length: 30

  Default Value: QUOTA

  The code indicating the type of the sales credit, such as quota or non-quota. A list of valid values is defined in the lookup MOO_SALES_CREDIT_TYPE.
• SalesMethodId: integer (int64)
  Title: Sales Method

  Read Only: true

  The unique identifier of the sales method for this revenue line.
• ScheduleAction: string
  Title: Schedule Action

  The transient attribute. Web services need to pass a value to indicate the action to be taken on recurring schedule such as create, delete, extend, and replace.
• ScheduleNonRecurringAmount: number
  Title: Nonrecurring Amount for Schedule

  The non recurring amount based on the set schedule.
• ScheduleRecurringAmount: number
  Title: Recurring Amount for Schedule

  The recurring amount based on the set schedule.
• ScheduleUsageAmount: number
  Title: Usage Amount for Schedule

  The usage amount based on the set schedule.
• SplitParentRevnId: integer (int64)
  Title: Split Parent Revenue ID

  The unique identifier of the split parent revenue.
• SplitPercent: number
  Title: Sales Credit

  The percentage of split revenue.
• SplitTypeCode: string
  Title: Split Type Code

  Maximum Length: 30

  The code indicating the Split type of the Revenue, such as ParentSplit or ChildSplit. A list of valid values is defined in the lookup MOO_REVN_SPLIT_TYPE.
• StatusCd: string
  Title: Opportunity Status

  Read Only: true

  Maximum Length: 30

  The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.
• SubscriptionId: integer (int64)
  Title: Subscription Id

  The unique identifier of the subscription.
• SubscriptionLineId: integer (int64)
  Title: Subscription Line Id

  The unique identifier of the subscription line within a subscription.
• SummaryRevnAmt: number
  Title: Opportunity Revenue

  Read Only: true

  Default Value: 0

  The revenue amount associated with the summary revenue line.
• SummaryRevnAmtInCorpCur: number
  Title: Opportunity Summary Revenue in Corporate Currency

  Read Only: true

  The calculated opportunity amount in corporate currency.
• SumRevnDownsideAmt: number
  Title: Opportunity Worst Case

  Read Only: true

  Default Value: 0

  The minimum amount of the summary revenue line for the opportunity.
• SumRevnUpsideAmt: number
  Title: Opportunity Best Case

  Read Only: true

  Default Value: 0

  The maximum amount of the summary revenue line for the opportunity.
• TargetPartyId: integer (int64)
  Title: Account Party ID

  The unique identifier of the sales account that owns the opportunity.
• TerrOwnerOrganizationId: integer
  Read Only: true

  The unique identifier of the organization the territory owner of this revenue line belongs to.
• TerrOwnerPartyName: string
  Title: Forecast Territory Owner

  Read Only: true

  Maximum Length: 360

  The party name for the territory owner of this revenue line.
• TerrOwnerResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  The unique identifier for the territory owner of this revenue line.
• TimeFilter: string
  Title: Close Period

  Read Only: true

  The names of the filter on which opportunities can be filtered based on effective date range.
• TypeCode: string
  Title: Revenue Type

  Maximum Length: 30

  The code indicating the type of revenue earned from this opportunity. A list of valid values is defined in the lookup MOO_SETID_REVENUE_TYPE.
• UnitPrice: number
  Title: Estimated Price

  The estimated unit price for the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure code for the product.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the revenue line can be updated. If the value is Y, then the note can be updated. The default value is Y.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line.
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group associated with the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "AmountAggregatedForScheduleFlag":{
            "title":"Divide Amount by Transactions",
            "maxLength":"1",
            "type":"boolean",
            "description":"The amounts are divided by the number of transactions based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Update Date",
            "type":"string",
            "description":"The date when the opportunity record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupModelLine":{
            "title":"Product Group Model Line",
            "maxLength":"1000",
            "type":"string",
            "description":"The model line associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrStgId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The sales stage identifier of this revenue line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevnCreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the revenue item was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ProdGroupModelConfigAttributes":{
            "title":"Product Group Model Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The model configuration attributes associated with the product group in revenue line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CrmCurcyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The common CRM currency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevnCategoryCode":{
            "title":"Revenue Category",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the revenue category used in Revenue Line Set functionality. A list of valid values is defined in the lookup MOO_REVN_CATEGORY.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerrOwnerOrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the organization the territory owner of this revenue line belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact of this child revenue.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenueTerritory":{
            "title":"Opportunity Revenue Territories",
            "type":"array",
            "description":"The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-RevenueTerritory-item-response"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity associated to child revenue.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The unit of measure code for the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId",
                    "InventoryOrgId"
                ]
            }
        },
        "CommitFlag":{
            "title":"Forecast",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the revenue's primary partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the sales account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditRcptPartOrgPartyId":{
            "title":"Credit Recipient Partner",
            "type":"integer",
            "description":"The unique identifier of the credit recipient partner organization party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleRecurringAmount":{
            "title":"Recurring Amount for Schedule",
            "type":"number",
            "description":"The recurring amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyUsageRevenue":{
            "title":"Monthly Usage Revenue",
            "type":"number",
            "description":"The monthly usage revenue on the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the child revenue record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RecurEndDate":{
            "title":"End By",
            "type":"string",
            "description":"The date when the child revenue recurrence ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Product",
            "type":"integer",
            "description":"The unique identifier of the product in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of product on the revenue line, such as item or product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "InventoryOrgId":{
            "title":"Product",
            "type":"integer",
            "description":"The unique identifier of the organization in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TerrOwnerPartyName":{
            "title":"Forecast Territory Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The party name for the territory owner of this revenue line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RevnLineTypeCode":{
            "title":"Revenue Line Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of revenue line, such as Opportunity Summary Revenue, Standard Revenue, and so on. A list of valid values is defined in the lookup MOO_REVN_LINE_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleUsageAmount":{
            "title":"Usage Amount for Schedule",
            "type":"number",
            "description":"The usage amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnLastUpdateDate":{
            "title":"Update Date",
            "type":"string",
            "description":"The date and time when the revenue record was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SumRevnUpsideAmt":{
            "title":"Opportunity Best Case",
            "type":"number",
            "description":"The maximum amount of the summary revenue line for the opportunity.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity revenue can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Revenue Opportunity ID",
            "type":"integer",
            "description":"The unique identified of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductConfigurableFlag":{
            "title":"Configurable Product",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a product allows configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SplitTypeCode":{
            "title":"Split Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the Split type of the Revenue, such as ParentSplit or ChildSplit. A list of valid values is defined in the lookup MOO_REVN_SPLIT_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "productGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The product group resource is used to view the product groups associated with an opportunity. 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/opportunities-ChildRevenue-productGroups-item-response"
            }
        },
        "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
        },
        "SubscriptionLineId":{
            "title":"Subscription Line Id",
            "type":"integer",
            "description":"The unique identifier of the subscription line within a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevnSequenceNumber":{
            "title":"Line Set",
            "type":"integer",
            "description":"The revenue sequence number.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "PartEngagementTypeCd":{
            "title":"Lead Registration Type",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the type of partner engagement.",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"Monthly Recurring Revenue",
            "type":"number",
            "description":"The monthly recurring revenue on the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractStartDate":{
            "title":"Contract Start Date",
            "type":"string",
            "description":"The start date of the contract for the quote.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "Discount":{
            "title":"Discount",
            "type":"number",
            "description":"The discount percent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2",
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "Description":{
            "title":"Product",
            "maxLength":"240",
            "type":"string",
            "description":"The user-provided description of the product associated with the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number for the owner of child revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumberInternal":{
            "title":"Item Number Internal",
            "maxLength":"300",
            "type":"string",
            "description":"The unique internal identifier of the product that is associated with the revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerDealProtectedDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date when the owner deal starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ChildSplitRevenue":{
            "title":"Child Split Revenues",
            "type":"array",
            "description":"The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-ChildSplitRevenue-item-response"
            }
        },
        "NqSplitAllocTypeCode":{
            "title":"Allocation Style",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrCmptPartyId":{
            "title":"Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor of this child revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The products resource is used to view the products associated with an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-products-item-response"
            }
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":"255",
            "type":"string",
            "description":"The asset key from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "SubscriptionId":{
            "title":"Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExpectDlvryDate":{
            "title":"Expected Delivery Date",
            "type":"string",
            "description":"The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ProductModelConfigAttributes":{
            "title":"Product Model Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The model configuration attributes associated with the product in revenue line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriceTypeCode":{
            "title":"Price Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of pricing associated with the revenue line. The list of valid values are Mixed, Usage, Recurring, and One Time.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurringRevenue":{
            "title":"Recurring Revenues",
            "type":"array",
            "description":"The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.",
            "items":{
                "$ref":"#/components/schemas/opportunities-ChildRevenue-RecurringRevenue-item-response"
            }
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the primary competitor of this child revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "RevnAmountCurcyCode":{
            "title":"Line Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryOrganizationName":{
            "type":"string",
            "description":"The name of the business unit to which this revenue line belongs.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SummaryRevnAmt":{
            "title":"Opportunity Revenue",
            "type":"number",
            "description":"The revenue amount associated with the summary revenue line.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ContractEndDate":{
            "title":"Contract End Date",
            "type":"string",
            "description":"The end date of the contract for the quote.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ProductModelName":{
            "title":"Product Model",
            "maxLength":"1000",
            "type":"string",
            "description":"The model name associated with the product in revenue line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCd":{
            "title":"Opportunity Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "OpportunityCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":"255",
            "type":"string",
            "description":"The root asset key of the parent from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "CrmConversionRate":{
            "title":"CRM Conversion Rate",
            "type":"number",
            "description":"The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitPrice":{
            "title":"Estimated Price",
            "type":"number",
            "description":"The estimated unit price for the product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":"255",
            "type":"string",
            "description":"The root asset key obtained from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":"50",
            "type":"string",
            "description":"The code indicating the sales channel for the child revenue. A list of valid values is defined in the lookup ZPM_SALES_CHANNEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RecurQuantity":{
            "title":"Recurring Quantity",
            "type":"number",
            "description":"The quantity of the child revenue recurrence.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the revenue for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecurTypeCode":{
            "title":"Recurrence Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating if the line is a standard revenue line or a recurring revenue line. A list of valid values is defined in the lookup MOO_REVN_RECUR_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the Business Unit that owns the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":"18"
            },
            "x-queryable":true
        },
        "SplitParentRevnId":{
            "title":"Split Parent Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the split parent revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MarginAmount":{
            "title":"Margin",
            "type":"number",
            "description":"The margin amount for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method for this revenue line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"The version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TimeFilter":{
            "title":"Close Period",
            "type":"string",
            "description":"The names of the filter on which opportunities can be filtered based on effective date range.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "RecurRevnAmount":{
            "title":"Scheduled Revenue Amount",
            "type":"number",
            "description":"The amount of revenue from the child revenue recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the recurrence starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyName2":{
            "title":"Sales Credit Recipient",
            "maxLength":"360",
            "type":"string",
            "description":"The name of this sales credit recipient.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "ProductModelLine":{
            "title":"Product Model Line",
            "maxLength":"1000",
            "type":"string",
            "description":"The model line associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code indicating the status of the child revenue. A list of valid values is defined in the lookup OPTY_STATUS.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "AttributeType":"Picklist",
                "Dependencies":"BUOrgId"
            },
            "x-queryable":true
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The user-editable unique identifier for the child revenue. The default value is the revenue identifier.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OwnerDealExpirationDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date when the owner deal expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "ScheduleAction":{
            "title":"Schedule Action",
            "type":"string",
            "description":"The transient attribute. Web services need to pass a value to indicate the action to be taken on recurring schedule such as create, delete, extend, and replace.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductModelFamily":{
            "title":"Product Model Family",
            "maxLength":"1000",
            "type":"string",
            "description":"The model family associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleNonRecurringAmount":{
            "title":"Nonrecurring Amount for Schedule",
            "type":"number",
            "description":"The non recurring amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The name of the predefined opportunity search filters.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyLeadId":{
            "title":"Opportunity Lead",
            "type":"integer",
            "description":"The unique Identifier of the lead associated with opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Name1":{
            "title":"Forecast Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RecurUpsideAmount":{
            "title":"Recurring Best Case",
            "type":"number",
            "description":"The maximum revenue amount from the recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "PrPartOrgPartyId":{
            "title":"Partner",
            "type":"integer",
            "description":"The unique identifier of the primary revenue partner organization party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CalculatedLineRevnAmtInCorpCur":{
            "title":"Revenue in Corporate Currency",
            "type":"number",
            "description":"The calculated revenue amount in corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The reference number of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "RecurDownsideAmount":{
            "title":"Recurring Worst Case",
            "type":"number",
            "description":"The minimum revenue amount from the recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date for the territory owner.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"The unique identifier of the primary territory for this revenue item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompetitorPartyName":{
            "title":"Competitor Party Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the primary competitor of this child revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OpportunityOwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesCreditTypeCode":{
            "title":"Sales Credit Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the sales credit, such as quota or non-quota. A list of valid values is defined in the lookup MOO_SALES_CREDIT_TYPE.",
            "nullable":true,
            "default":"QUOTA",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "RecurParentRevnId":{
            "title":"Recurring Revenue Parent ID",
            "type":"integer",
            "description":"The unique identifier for the parent revenue of the recurring revenue lines.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurPeriodOrEndDateCode":{
            "title":"Recurrence Period or End Date Code",
            "type":"string",
            "description":"The code that indicates if a date or the number of recurrences are specified to end the recurrences.",
            "nullable":true,
            "default":"EndAfter",
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RecurEndDate"
                ]
            }
        },
        "ParentRevnId":{
            "title":"Parent Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the parent revenue line, used for Lineset functionality.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurUnitPrice":{
            "title":"Recurring Estimated Price",
            "type":"number",
            "description":"The price of each child revenue recurrence.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of the revenue owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OpportunityCurrencyCode":{
            "title":"Opportunity Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the opportunity. 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,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ProdGroupModelName":{
            "title":"Product Group Model",
            "maxLength":"1000",
            "type":"string",
            "description":"The model name associated with the product group in revenue line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerrOwnerResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier for the territory owner of this revenue line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount associated with the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RevenueTypeCategory":{
            "title":"Revenue Type Category",
            "maxLength":"30",
            "type":"string",
            "description":"The revenue category type on the opportunity revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SumRevnDownsideAmt":{
            "title":"Opportunity Worst Case",
            "type":"number",
            "description":"The minimum amount of the summary revenue line for the opportunity.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ProdGroupModelFamily":{
            "title":"Product Group Model Family",
            "maxLength":"1000",
            "type":"string",
            "description":"The model family associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization to which the product belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CrmConversionRateType":{
            "title":"CRM Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.",
            "nullable":true,
            "x-queryable":false
        },
        "PartOrgPartyName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary partner associated with the child revenue.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OpportunityPrSrcNumber":{
            "title":"Primary Source",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate key identifier of the primary marketing source or campaign that generated this opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.",
            "nullable":true,
            "x-queryable":false
        },
        "SummaryRevnAmtInCorpCur":{
            "title":"Opportunity Summary Revenue in Corporate Currency",
            "type":"number",
            "description":"The calculated opportunity amount in corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the revenue line can be updated. If the value is Y, then the note can be updated. The default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The alternate key identifier of the product that is associated with the revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InventoryOrgId"
                ]
            }
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary contact of this child revenue.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Revenue Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecurFrequencyCode":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the frequency of recurrence for the child revenue. A list of valid values is defined in the lookup MOO_RECURRING_FREQUENCY.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount",
                    "NonRecurringRevenue",
                    "RecurRevenue",
                    "UsageRevenue",
                    "RevnAmount"
                ]
            }
        },
        "CostAmount":{
            "title":"Cost",
            "type":"number",
            "description":"The cost amount for the opportunity.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "CustomerRegistryId":{
            "title":"Account Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the opportunity account registry ID.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RevnAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of revenue that is earned from this opportunity.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount",
                    "NonRecurringRevenue",
                    "RecurRevenue",
                    "UsageRevenue"
                ]
            },
            "x-queryable":true
        },
        "SalesAccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the opportunity sales account.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TypeCode":{
            "title":"Revenue Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of revenue earned from this opportunity. A list of valid values is defined in the lookup MOO_SETID_REVENUE_TYPE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"BUOrgId"
            }
        },
        "OpportunityOwnerPartyName":{
            "title":"Opportunity Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the opportunity owner.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Line Comments",
            "maxLength":"250",
            "type":"string",
            "description":"The user-provided comments for the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyEffectiveDate":{
            "title":"Opportunity Close Date",
            "type":"string",
            "description":"The date when the opportunity is expected to close.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of product for this opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            },
            "x-queryable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "RecurNumberPeriods":{
            "title":"End After",
            "type":"integer",
            "description":"The number of times the child revenue should recur.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ActualCloseDate":{
            "title":"Actual Close Date",
            "type":"string",
            "description":"The date when the revenue line was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupQuotableFlag":{
            "title":"Quotable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a product group is quotable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartOrgPartyId":{
            "title":"Partner Organization Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary revenue partner party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CloseReasonCode":{
            "title":"Win/Loss Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the reason for winning or losing the revenue. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"BUOrgId"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date for the territory owner.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the child revenue closes. The default value is the opportunity's close date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Child Split Revenues

Type: array

Title: Child Split Revenues

The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.

Show Source

• Array of: object opportunities-ChildRevenue-ChildSplitRevenue-item-response

{
    "title":"Child Split Revenues",
    "type":"array",
    "description":"The child split revenue resource is used to view, create, update, and delete a split revenue. The revenue or nonrevenue credit is allocated to the resource which has contributed to the selling effort for an opportunity revenue line.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-ChildSplitRevenue-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 : Product Groups

Type: array

Title: Product Groups

The product group resource is used to view the product groups associated with an opportunity. 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 opportunities-ChildRevenue-productGroups-item-response

{
    "title":"Product Groups",
    "type":"array",
    "description":"The product group resource is used to view the product groups associated with an opportunity. 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/opportunities-ChildRevenue-productGroups-item-response"
    }
}

Nested Schema : Products

Type: array

Title: Products

The products resource is used to view the products associated with an opportunity.

Show Source

• Array of: object opportunities-ChildRevenue-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The products resource is used to view the products associated with an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-products-item-response"
    }
}

Nested Schema : Recurring Revenues

Type: array

Title: Recurring Revenues

The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.

Show Source

• Array of: object opportunities-ChildRevenue-RecurringRevenue-item-response

{
    "title":"Recurring Revenues",
    "type":"array",
    "description":"The recurring revenues resource is used to view, create, update, and delete a recurring revenue. The revenues that span over a period of time sourced from the same product on an opportunity.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-RecurringRevenue-item-response"
    }
}

Nested Schema : Opportunity Revenue Territories

Type: array

Title: Opportunity Revenue Territories

The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.

Show Source

• Array of: object opportunities-ChildRevenue-RevenueTerritory-item-response

{
    "title":"Opportunity Revenue Territories",
    "type":"array",
    "description":"The opportunity revenue territories resource is used to view, create, update, and delete the revenue territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.",
    "items":{
        "$ref":"#/components/schemas/opportunities-ChildRevenue-RevenueTerritory-item-response"
    }
}

Nested Schema : opportunities-ChildRevenue-ChildSplitRevenue-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• ExtnPartyName: string
  Title: Owner

  The name of the revenue owner.
• ExtnPartyNameLOVSwitcher: string
  The switcher for ist of values for the revenue owner, used in UI scenarios.
• ForecastTerritoryName: string
  Title: Territory Name

  Maximum Length: 60

  The name of the forecast territory.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Organization

  Read Only: true

  The name of the resource organization associated the with revenue.
• OwnerLockAsgnFlag: boolean
  Title: Lock Credit Owner

  Maximum Length: 1

  Default Value: false

  Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The party number for the owner of child split revenue.
• PrTerritoryUpdatedByPartyName: string
  Title: Updated By

  Read Only: true

  Maximum Length: 360

  The name of the user who last updated the forecast territory.
• PrTerritoryVersionId: integer (int64)
  Title: Forecast Territory

  Forecast territory version identifier.
• PrTerritoryVersionIdForManual: string
  Title: Manually Assigned Territory Version ID

  Indicates the version ID of a territory that is to be manually assigned to the revenue record.
• ResourcePartyId: integer (int64)
  Title: Owner

  The identifier of the resource associated with the child split revenue.
• RevnAmount: number
  Title: Line Revenue

  Default Value: 0

  The revenue amount.
• RevnAmountCurcyCode: string
  Title: Currency

  Maximum Length: 15

  The currency the amount on this revenue line is based on.
• RevnId: integer (int64)
  The unique identifier of the child split revenue.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  The unique number for the revenue line.
• SalesCreditTypeCode: string
  Title: Sales Credit Type

  Maximum Length: 30

  Default Value: QUOTA

  Indicates the type of credit.
• SplitPercent: number
  Title: Sales Credit

  The percentage of split revenue.
• TerrOwnerPartyName: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The name of the forecast territory owner.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number for the owner of child split revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"Forecast territory version identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExtnPartyName":{
            "title":"Owner",
            "type":"string",
            "description":"The name of the revenue owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ExtnPartyNameLOVSwitcher":{
            "type":"string",
            "description":"The switcher for ist of values for the revenue owner, used in UI scenarios.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SalesCreditTypeCode"
                ]
            }
        },
        "PrTerritoryUpdatedByPartyName":{
            "title":"Updated By",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the user who last updated the forecast territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"Indicates the version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TerrOwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the forecast territory owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditTypeCode":{
            "title":"Sales Credit Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of credit.",
            "nullable":true,
            "default":"QUOTA",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the resource organization associated the with revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number for the revenue line.",
            "nullable":false,
            "x-queryable":true
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the child split revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The identifier of the resource associated with the child split revenue.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ExtnPartyName",
                    "PartyName"
                ]
            },
            "x-queryable":true
        },
        "ForecastTerritoryName":{
            "title":"Territory Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the forecast territory.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RevnAmountCurcyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency the amount on this revenue line is based on.",
            "nullable":false,
            "x-queryable":true
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"The revenue amount.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "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 : opportunities-ChildRevenue-productGroups-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The user-provided 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":"The user-provided 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 : opportunities-ChildRevenue-products-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Indicates if the product is Active.
• CSSEnabled: string
  Read Only: true

  Indicates if the product is enabled for customer self-service. The default value is No.
• Description: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The description of the product associated with the opportunity.
• EndDate: string (date-time)
  Title: Effective to Date

  Read Only: true

  The date after which the product is no longer available.
• InventoryItemId: integer
  Title: Inventory Item ID

  Read Only: true

  The unique identifier of the product inventory item associated with the opportunity.
• 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 alternate key identifier 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 whether the product is serviceable. If the value is True, then the product is serviceable.
• StartDate: string (date-time)
  Title: Effective from Date

  Read Only: true

  The date from which the product is available.
• 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":"The description of the product associated with the opportunity.",
            "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 product inventory item associated with the opportunity.",
            "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 if the product is enabled for customer self-service. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the product is no longer available.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "type":"boolean",
            "description":"Indicates if the product is Active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the product is available.",
            "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 whether the product is serviceable. If the value is True, then the product is serviceable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductNum":{
            "title":"Product Number",
            "type":"string",
            "description":"The alternate key identifier 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 : opportunities-ChildRevenue-RecurringRevenue-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• EffectiveDate: string (date)
  Title: Line Close Date

  Estimated close date for this revenue - defaulted from opportunity's close date.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The non recurring revenue amount on the revenue line.
• Quantity: number
  Title: Quantity

  Product quantity.
• RecurParentRevnId: integer (int64)
  Indicates the parent revenue id for the recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line.
• RevnAmount: number
  Title: Line Revenue

  Default Value: 0

  Revenue amount.
• RevnAmtCurcyCode: string
  Read Only: true

  The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• RevnId: integer (int64)
  Revenue identifier.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnAmtCurcyCode":{
            "type":"string",
            "description":"The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":"30",
            "type":"string",
            "description":"User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.",
            "nullable":false,
            "x-queryable":true
        },
        "RecurParentRevnId":{
            "type":"integer",
            "description":"Indicates the parent revenue id for the recurrence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"Revenue identifier.",
            "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"
            }
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"Revenue amount.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Line Close Date",
            "type":"string",
            "description":"Estimated close date for this revenue - defaulted from opportunity's close date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        }
    }
}

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 : opportunities-ChildRevenue-RevenueTerritory-item-response

Type: object

Show Source

• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  Maximum Length: 15

  The type of assignment used to assign the territory to the opportunity.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the revenue territory record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• EffectiveEndDate: string (date)
  The date when the resource organization assignment to the territory ends.
• EffectiveStartDate: string (date)
  The date when the resource organization for the territory was assigned to the revenue line.
• ForecastParticipationCode: string
  Title: Forecast Participation

  Read Only: true

  Maximum Length: 30

  The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Revenue Line Territory

  Read Only: true

  Maximum Length: 60

  The name of the territory that the opportunity belongs to.
• Name1: string
  Title: Organization

  The name of the organization that the territory resource belongs to.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the resource who owns the territory.
• PartyName: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The name of the territory owner for the opportunity.
• RevnId: integer (int64)
  The unique identifier of the revenue.
• RevnTerrId: integer (int64)
  The unique identifier of the revenue territory.
• RoleId: integer
  The unique identifier of the resource's role.
• RoleName: string
  The name of the resource's role.
• TerritoryId: integer (int64)
  The unique identifier of the territory.
• TerritoryVersionId: integer (int64)
  The unique identifier of the territory version.
• TypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the revenue territory record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the resource organization assignment to the territory ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the territory owner for the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnTerrId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Revenue Line Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the territory that the opportunity belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Forecast Participation",
            "maxLength":"30",
            "type":"string",
            "description":"The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource who owns the territory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":"15",
            "type":"string",
            "description":"The type of assignment used to assign the territory to the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the resource organization for the territory was assigned to the revenue line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Name1":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the organization that the territory resource belongs to.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "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 : opportunities-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 : opportunities-Note-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the relationship that is populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the note record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the note record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique party identifier for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  The formatted address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The formatted phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the note data was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of a note for the opportunity.
• NoteNumber: string
  Maximum Length: 30

  The system generated number. It can be generated from external system also (user key).
• 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 used to classify a note, as asset or adjustment.
• 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 party to which the note is associated.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of party associated with the opportunity.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on.
• 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 party associated with the opportunity.",
            "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 that is populated when the note is associated with a 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 number. It can be generated from external system also (user key).",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.",
            "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 formatted 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 contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "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 a note for the opportunity.",
            "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 for the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The formatted 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 used to classify a note, as asset or adjustment.",
            "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 unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique Identifier of the party to which the note 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 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 : opportunities-OpportunityCampaigns-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 opportunity belongs.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table.
• 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 opportunity 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 opportunity campaign data was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date and time when this record is created.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyCampaignId: integer (int64)
  Title: Opportunity Campaign ID

  The unique identifier of the opportunity campaign.
• OptyCampaignNumber: string
  Title: Opportunity Campaign Number

  Maximum Length: 30

  The unique alternate identifier for the Opportunity Campaign.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity. It is the reference key to opportunity header.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The alternate identifier for current opportunity.
• PrimaryFlag: boolean
  Title: Primary

  Indicates whether the campaign is primary for the opportunity.
• RevenuePercentage: number
  Title: Revenue Percentage

  To store the percentage value of the opportunity's revenue shared by one or more campaigns.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date and time when this record is created.",
            "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 opportunity 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 opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CampaignId"
                ]
            },
            "x-queryable":true
        },
        "RevenuePercentage":{
            "title":"Revenue Percentage",
            "type":"number",
            "description":"To store the percentage value of the opportunity's revenue shared by one or more campaigns.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignName":{
            "title":"Campaign Name",
            "maxLength":"100",
            "type":"string",
            "description":"The campaign to which the current opportunity belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCampaignId":{
            "title":"Opportunity Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity. It is the reference key to opportunity header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OptyCampaignNumber":{
            "title":"Opportunity Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the Opportunity Campaign.",
            "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 opportunity campaign number public surrogate key for OPTY_CAMPAIGN_NUMBER table.",
            "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"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate identifier for current opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the opportunity 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 : opportunities-OpportunityCompetitor2-item-response

Type: object

Show Source

• CmptPartyId: integer (int64)
  Title: Party ID

  The unique identifier for the competitor party.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments about the opportunity's competitor.
• CompetitorPartyNumber: string
  Title: Competitor Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the competitor party.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the contact record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Opportunity Name

  Read Only: true

  Maximum Length: 275

  The name of the opportunity.
• OptyCompetitorId: integer (int64)
  Title: Opportunity Competitor ID

  The unique identifier for the competitor of the opportunity.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier for the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• PartyName: string
  Title: Competitor

  Maximum Length: 360

  The name of the party.
• PrimaryFlg: string
  Title: Primary

  Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.
• ThreatLevelCode: string
  Title: Threat Level

  Maximum Length: 30

  The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

{
    "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 and time when the contact record was created.",
            "format":"date-time",
            "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
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"The user-provided comments about the opportunity's competitor.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Competitor",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Opportunity Name",
            "maxLength":"275",
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompetitorPartyNumber":{
            "title":"Competitor Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the competitor party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyCompetitorId":{
            "title":"Opportunity Competitor ID",
            "type":"integer",
            "description":"The unique identifier for the competitor of the opportunity.",
            "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"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":false
        },
        "CmptPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the competitor party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors"
            },
            "x-queryable":true
        },
        "ThreatLevelCode":{
            "title":"Threat Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of threat or risk from the competitor. The list of valid values are Low, Medium, and High. A list of accepted values is defined in the lookup Competitor Threat Level. 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"
            }
        },
        "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
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to 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 : opportunities-OpportunityContact-item-response

Type: object

Show Source

• AffinityLvlCd: string
  Title: Affinity Level

  Maximum Length: 30

  The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• Comments: string
  Title: Comments

  Maximum Length: 255

  The textual comments about the contact on the current opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContactedFlg: string
  Title: Contacted

  Maximum Length: 1

  Default Value: N

  Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
• ContactPartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the opportunity contact party.
• ContactPointId: integer
  The unique identifier of the contact point for an opportunity contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the opportunity contact record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the contact record was created.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.
• EmailAddress: string
  Title: Email

  Read Only: true

  The e-mail address of the contact.
• EmailPreference: string
  Title: Email Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the opportunity contact has an email preference of do not email, ok to email, or no value.
• FormattedAddress: string
  Title: Address

  Read Only: true

  Maximum Length: 255

  The formatted address of the contact.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the contact.
• InfluenceLvlCd: string
  Title: Influence Level

  Maximum Length: 30

  The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• JobTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The free form text for job title of the opportunity contact.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyConId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the opportunity.
• OptyId: integer (int64)
  Title: Opportunity

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OrganizationPartyId: integer (int64)
  Read Only: true

  The unique identifier of the contact's organization.
• OrganizationPartyName: string
  Title: Organization

  Read Only: true

  Maximum Length: 360

  The name of the contact's organization.
• OrgContactId: integer (int64)
  Read Only: true

  The unique identifier of the organization contact for the opportunity.
• PartyName: string
  Title: Opportunity Contact Name

  Read Only: true

  Maximum Length: 360

  The name of the contact for the opportunity.
• PartyUniqueName: string
  Title: Related Account

  Read Only: true

  Maximum Length: 900

  The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.
• PERPartyId: integer (int64)
  Title: Opportunity Contact

  The party identifier of the opportunity contact.
• PersonCentricJobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the contact person.
• PhonePreference: string
  Title: Phone Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the opportunity contact has a phone preference of do not call, ok to call, or no value.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
• PrimaryFlg: string
  Title: Primary

  Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.
• RelationshipCode: string
  Title: Relationship Code

  Read Only: true

  Maximum Length: 30

  The code indicating whether it's a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
• RelationshipId: integer (int64)
  The identifier of the relationship for the opportunity contact.
• RoleCd: string
  Title: Function

  Maximum Length: 30

  The code identifying the roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• SalesAffinityCode: string
  Title: Affinity

  Read Only: true

  Maximum Length: 30

  The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• SalesBuyingRoleCode: string
  Title: Buying Role

  Read Only: true

  Maximum Length: 30

  The code identifying the roles played by a contact in the buying process. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• SalesInfluenceLevelCode: string
  Title: Influence Level

  Read Only: true

  Maximum Length: 30

  The code indicating the influence the opportunity contact has on the buying process of the current opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactedFlg":{
            "title":"Contacted",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OptyConId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationPartyId":{
            "type":"integer",
            "description":"The unique identifier of the contact's organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyUniqueName":{
            "title":"Related Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Opportunity Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact for the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "dependencies":[
                    "PERPartyId",
                    "RelationshipId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title of the opportunity contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationPartyName":{
            "title":"Organization",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact's organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhonePreference":{
            "title":"Phone Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the opportunity 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":[
                    "PartyId"
                ]
            }
        },
        "OrgContactId":{
            "type":"integer",
            "description":"The unique identifier of the organization contact for the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether it's a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the contact point for an opportunity contact.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SalesInfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the influence the opportunity contact has on the buying process of the current opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RelationshipId"
                ]
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "PERPartyId":{
            "title":"Opportunity Contact",
            "type":"integer",
            "description":"The party identifier of the opportunity contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The textual comments about the contact on the current opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "InfluenceLvlCd":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "maxLength":"255",
            "type":"string",
            "description":"The formatted address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailPreference":{
            "title":"Email Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the opportunity 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":[
                    "PartyId"
                ]
            }
        },
        "PersonCentricJobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleCd":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifying the roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifying the roles played by a contact in the buying process. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipId"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "OptyId":{
            "title":"Opportunity",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The identifier of the relationship for the opportunity contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AffinityLvlCd":{
            "title":"Affinity Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of the opportunity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":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 : opportunities-OpportunityDeal-item-response

Type: object

Show Source

• ApprovedDate: string (date)
  Title: Approved Date

  Read Only: true

  The date and time when deal was approved.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the opportunity deal record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the opportunity deal record was created.
• DealExpirationDate: string (date)
  Title: Expiration Date

  Read Only: true

  The date and time when the deal is set to expire.
• DealId: integer
  Title: Deal ID

  The unique identifier of the deal.
• DealName: string
  Title: Deal Name

  Read Only: true

  Maximum Length: 250

  The name of the opportunity deal.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate key identifier of the deal registration.
• DealSize: number
  Title: Deal Size

  Read Only: true

  The size of the deal associated with the opportunity.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the opportunity deal record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the opportunity deal record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the opportunity deal record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyDealId: integer
  Title: Opportunity Deal ID

  Read Only: true

  The unique identifier of the opportunity deal.
• OptyId: integer
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• PartnerId: integer (int64)
  Title: Partner ID

  Read Only: true

  The unique identifier of the partner tracked in the deal.
• PartyName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The code indicating the status of the opportunity deal. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity deal record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity deal record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the deal.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity deal record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time when deal was approved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner tracked in the deal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The size of the deal associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the opportunity deal. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date and time when the deal is set to expire.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealName":{
            "title":"Deal Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the opportunity deal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyDealId":{
            "title":"Opportunity Deal ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity deal.",
            "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"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the opportunity deal record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the opportunity deal 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 : opportunities-OpportunityLead-item-response

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContactName: string
  Title: Contact

  Read Only: true

  Maximum Length: 450

  The name of the primary lead contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedByModule: string
  Title: Created by Module

  Read Only: true

  Maximum Length: 30

  The module through which the record was created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• CustomerId: integer (int64)
  Title: Customer Identifier

  Read Only: true

  The unique identifier of the customer record in the TCA schema.
• CustomerName: string
  Title: Customer

  Read Only: true

  Maximum Length: 360

  The name of the customer.
• DealEstimatedCloseDate: string (date)
  Title: Deal Registration Estimated Close Date

  The date when the deal registration for the opportunity is estimated to be closed.
• DealExpirationDate: string (date)
  Title: Deal Expiration Date

  The date when the lead registration will expire.
• DealPartProgramId: integer (int64)
  Title: Partner Program ID

  The unique identifier of the partner program associated with the lead registration.
• DealSize: number
  Title: Deal Size

  Read Only: true

  The deal size of the deal associated with the opportunity.
• DealType: string
  Title: Lead Registration Type

  Maximum Length: 30

  The deal or lead registration type for the opportunity.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• LeadAging: integer
  Title: Age in Days

  Read Only: true

  The number of days elapsed since the lead was created.
• LeadId: integer (int64)
  Title: Lead Identifier

  Read Only: true

  The unique identifier of the lead for the opportunity.
• LeadName: string
  Title: Lead Name

  Read Only: true

  Maximum Length: 250

  The name of the lead associated with the opportunity.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 64

  The alternate key identifier of the lead.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectUsage: string
  Title: Object Usage

  Maximum Length: 30

  Indicates whether the current record represents a lead or a deal.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyLeadId: integer (int64)
  Title: Opportunity Lead ID

  The unique identifier of the lead for the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• PartnerTypeCd: string
  Title: Partner Type

  Maximum Length: 250

  The code indicating the type of the partner for the lead registration.
• PrDealPartOrgPartyId: integer (int64)
  Title: Partner Organization Party ID

  The unique identifier for the partner on the lead registration.
• PrDealPartResourcePartyId: integer (int64)
  Title: Primary Partner Resource ID

  The unique identifier for the primary partner resource on the lead registration.
• PrimaryContactId: integer (int64)
  Title: Primary Contact Identifier

  Read Only: true

  The unique identifier of the sales lead contact marked as a primary lead contact.
• Rank: string
  Title: Rank

  Read Only: true

  Maximum Length: 30

  The rank of the lead associated with the opportunity.
• RankMeaning: string
  Title: Rank

  Read Only: true

  The meaning of the rank code for the associated lead.
• RegistrationNumber: string
  Title: Registration Number

  Maximum Length: 120

  The unique registration number of the lead for the opportunity.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The code indicating the status of the opportunity lead.
• StatusCodeMeaning: string
  Title: Status

  Read Only: true

  The meaning of the status code for the associated lead.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date and time when the opportunity lead was last updated from mobile.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactId":{
            "title":"Primary Contact Identifier",
            "type":"integer",
            "description":"The unique identifier of the sales lead contact marked as a primary lead contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time when the opportunity lead was last updated from mobile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the opportunity lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrDealPartOrgPartyId":{
            "title":"Partner Organization Party ID",
            "type":"integer",
            "description":"The unique identifier for the partner on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealPartProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the lead registration.",
            "format":"int64",
            "nullable":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 Identifier",
            "type":"integer",
            "description":"The unique identifier of the lead for the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"leads"
            },
            "x-queryable":true
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique registration number of the lead for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerTypeCd":{
            "title":"Partner Type",
            "maxLength":"250",
            "type":"string",
            "description":"The code indicating the type of the partner for the lead registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":"30",
            "type":"string",
            "description":"The module through which the record was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyLeadId":{
            "title":"Opportunity Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "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":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DealType":{
            "title":"Lead Registration Type",
            "maxLength":"30",
            "type":"string",
            "description":"The deal or lead registration type for the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "DealEstimatedCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration for the opportunity is estimated to be closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The deal size of the deal associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate key identifier of the lead.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "SmartPickerEntityName":"Lead"
            },
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "maxLength":"30",
            "type":"string",
            "description":"The rank of the lead associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerId":{
            "title":"Customer Identifier",
            "type":"integer",
            "description":"The unique identifier of the customer record in the TCA schema.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadAging":{
            "title":"Age in Days",
            "type":"integer",
            "description":"The number of days elapsed since the lead was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LeadCreationDate"
                ]
            }
        },
        "PrDealPartResourcePartyId":{
            "title":"Primary Partner Resource ID",
            "type":"integer",
            "description":"The unique identifier for the primary partner resource on the lead registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DealExpirationDate":{
            "title":"Deal Expiration Date",
            "type":"string",
            "description":"The date when the lead registration will expire.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RankMeaning":{
            "title":"Rank",
            "type":"string",
            "description":"The meaning of the rank code for the associated lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusCodeMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The meaning of the status code for the associated lead.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectUsage":{
            "title":"Object Usage",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the current record represents a lead or a deal.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadName":{
            "title":"Lead Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the lead associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":"450",
            "type":"string",
            "description":"The name of the primary lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "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
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to 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 : opportunities-OpportunityResource-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• AsgnTerritoryVersionId: integer (int64)
  Title: Territory

  The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the opportunity resource record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the resource record was created.
• DealExpirationDate: string (date)
  Title: Deal Protected to Date

  The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
• DealProtected: string
  Title: Deal Protected

  Read Only: true

  Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.
• DealProtectedDate: string (date)
  Title: Deal Protected from Date

  The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the opportunity team member.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the opportunity team member.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockAssignmentFlag: boolean
  Title: Lock Assignment

  Maximum Length: 1

  Default Value: true

  Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• MgrResourceId: integer
  Read Only: true

  The unique identifier of the resource team member's manager.
• OptyId: integer (int64)
  The unique Identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OptyResourceId: integer (int64)
  Title: Opportunity Resource ID

  The unique party identifier for the existing opportunity resource.
• OptyResourceNumber: string
  Title: Opportunity Resource Number

  Maximum Length: 30

  The alternate key identifier of the opportunity resource.
• OwnerFlag: boolean
  Title: Primary

  Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.
• PartnerOrgId: integer (int64)
  Title: Name

  The unique identifier of the partner organization.
• PartnerPartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the partner associated with the partner resource.
• PartyName: string
  Title: Team Member

  Read Only: true

  Maximum Length: 360

  The name of the opportunity team member.
• PersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the opportunity team member.
• PersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the opportunity team member.
• ResourceId: integer (int64)
  Title: Team Member

  The unique party identifier for the existing resource.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the opportunity resource party.
• RoleName: string
  Title: Role

  Read Only: true

  Maximum Length: 60

  The role of the opportunity team member in the resource organization.
• TerritoryName: string
  Title: Territory

  Read Only: true

  Maximum Length: 60

  The name of the opportunity team member's territory.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the resource record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryName":{
            "title":"Territory",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the opportunity team member's territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyName":{
            "title":"Team Member",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealProtectedDate":{
            "title":"Deal Protected from Date",
            "type":"string",
            "description":"The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerPartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the partner resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyResourceNumber":{
            "title":"Opportunity Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OptyResourceId":{
            "title":"Opportunity Resource ID",
            "type":"integer",
            "description":"The unique party identifier for the existing opportunity resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity resource party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerOrgId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "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"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "OwnerFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "DealExpirationDate":{
            "title":"Deal Protected to Date",
            "type":"string",
            "description":"The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique Identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealProtected":{
            "title":"Deal Protected",
            "type":"string",
            "description":"Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleName":{
            "title":"Role",
            "maxLength":"60",
            "type":"string",
            "description":"The role of the opportunity team member in the resource organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ResourceId":{
            "title":"Team Member",
            "type":"integer",
            "description":"The unique party identifier for the existing resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MgrResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource team member's manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Lock Assignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "AsgnTerritoryVersionId":{
            "title":"Territory",
            "type":"integer",
            "description":"The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to 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 : opportunities-OpportunityRollup-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 opportunity.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Read Only: true

  Maximum Length: 15

  The corporate currency code of the note associated with the rollup. 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 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 opportunity.
• LastCallMadeDate: string (date-time)
  Title: Last Call Made

  Read Only: true

  The date when last outbound call was made in context of the opportunity.
• LastCompletedActivity: string (date-time)
  Title: Last Completed Activity

  Read Only: true

  The date of last completed activity for an opportunity. 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 opportunity.
• LastTouchDate: string (date-time)
  Title: Last Touch Date

  Read Only: true

  The date of last touch in context of the opportunity. 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.
• 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 an opportunity.
• NumberOfOpenActivities: number
  Title: Total Open Activities

  Read Only: true

  The total number of activities that are open for the opportunity.
• NumberOfTouches: number
  Title: Total Touches

  Read Only: true

  The total number of touches in context of the opportunity. A touch refers to an outbound communication such as email sent or phone call made and so on.
• OptyId: integer (int64)
  Title: Opportunity Identifier

  Read Only: true

  The unique identifier of the opportunity.
• TotalCompletedActivities: number
  Title: Total Completed Activities

  Read Only: true

  The total number of completed activities for an opportunity.
• TotalNotes: number
  Title: Total Notes

  Read Only: true

  The total number of public notes associated with an opportunity.
• TotalQuotes: number
  Title: Total Quotes

  Read Only: true

  The total number of quotes for an opportunity.

{
    "type":"object",
    "properties":{
        "LastEmailSentDate":{
            "title":"Last Email Sent",
            "type":"string",
            "description":"The date when last email was sent in context of the opportunity.",
            "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 opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextTaskDue":{
            "title":"Next Task Due",
            "type":"string",
            "description":"The date when a task is due for an opportunity.",
            "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 opportunity. 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 an opportunity. 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 an opportunity.",
            "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 opportunity.",
            "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 opportunity.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCompletedActivities":{
            "title":"Total Completed Activities",
            "type":"number",
            "description":"The total number of completed activities for an opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity Identifier",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalQuotes":{
            "title":"Total Quotes",
            "type":"number",
            "description":"The total number of quotes for an opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfTouches":{
            "title":"Total Touches",
            "type":"number",
            "description":"The total number of touches in context of the opportunity. 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 opportunity.",
            "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"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the note associated with the rollup. 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,
            "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 : opportunities-OpportunitySource1-item-response

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyId: integer (int64)
  The unique Identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• OptySrcId: integer (int64)
  The unique Identifier of the source of the opportunity.
• SrcNumber: string
  Title: Source Code

  Maximum Length: 100

  A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on.
• UserLastUpdateDate: string (date-time)
  The date and time when the opportunity was last updated from mobile.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SrcNumber":{
            "title":"Source Code",
            "maxLength":"100",
            "type":"string",
            "description":"A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "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"
            }
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date and time when the opportunity was last updated from mobile.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique Identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OptySrcId":{
            "type":"integer",
            "description":"The unique Identifier of the source of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":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 : opportunities-opportunityStageSnapshots-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the opportunity stage snapshot is active.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the opportunity stage snapshot.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the opportunity stage snapshot was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the opportunity stage snapshot was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the opportunity stage snapshot.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the opportunity stage snapshot.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Sales Stage

  Read Only: true

  Maximum Length: 50

  The name of the opportunity stage snapshot.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyStgSnapshotId: integer (int64)
  Title: Opportunity Stage Snapshot ID

  The unique identifier of the opportunity stage snapshot.
• PhaseCd: string
  Title: Sales Stage Phase

  Read Only: true

  Maximum Length: 30

  Default Value: "B - Working the Deal"

  The current phase of the opportunity sales stage.
• QuotaFactor: number
  Title: Sales Stage Quota Factor

  Read Only: true

  The quota factor of the opportunity sales stage.
• StageStatusCd: string
  Title: Sales Stage Status

  Read Only: true

  Maximum Length: 30

  Default Value: "Open"

  The code indicating the default status for the opportunity's sales stage.
• StgEnterDate: string (date-time)
  Title: Sales Stage Enter Date

  The date when the opportunity entered a sales stage.
• StgExitDate: string (date-time)
  Title: Sales Stage Exit Date

  The date when the opportunity exited a sales stage.
• StgId: integer (int64)
  Title: Sales Stage ID

  The unique identifier of the opportunity sales stage.
• StgOrder: number
  Title: Sales Stage Order

  Read Only: true

  The order of the opportunity's sales stage in the sales method.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity stage snapshot.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the opportunity stage snapshot 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 opportunity stage snapshot.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StgId":{
            "title":"Sales Stage ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity sales stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhaseCd":{
            "title":"Sales Stage Phase",
            "maxLength":"30",
            "type":"string",
            "description":"The current phase of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "default":"\"B - Working the Deal\"",
            "x-queryable":true
        },
        "StgEnterDate":{
            "title":"Sales Stage Enter Date",
            "type":"string",
            "description":"The date when the opportunity entered a sales stage.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the opportunity stage snapshot is active.",
            "nullable":true,
            "x-queryable":true
        },
        "StgOrder":{
            "title":"Sales Stage Order",
            "type":"number",
            "description":"The order of the opportunity's sales stage in the sales method.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Sales Stage",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the opportunity stage snapshot.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuotaFactor":{
            "title":"Sales Stage Quota Factor",
            "type":"number",
            "description":"The quota factor of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "StgExitDate":{
            "title":"Sales Stage Exit Date",
            "type":"string",
            "description":"The date when the opportunity exited a sales stage.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StageStatusCd":{
            "title":"Sales Stage Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the default status for the opportunity's sales stage.",
            "nullable":true,
            "readOnly":true,
            "default":"\"Open\"",
            "x-queryable":true
        },
        "OptyStgSnapshotId":{
            "title":"Opportunity Stage Snapshot ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity stage snapshot.",
            "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":"The date when the opportunity stage snapshot 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 details of the user who last updated the opportunity stage snapshot.",
            "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 : opportunities-OpportunitySubscription-item-response

Type: object

Show Source

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

  Read Only: true

  Maximum Length: 15

  The currency associated with the subscription.
• DeleteFlag: boolean
  Title: Deleted

  Read Only: true

  Indicates whether the user has access to delete the record.
• EndDate: string (date)
  Title: Subscription End Date

  Read Only: true

  The end date of the subscription.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NetPrice: number
  Title: Total Contract Value

  Read Only: true

  The total contract value of the subscription.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptySubscriptionId: integer (int64)
  Title: Opportunity Subscription ID

  The primary key and the unique internal identifier of the row.
• OptySubscriptionNumber: string
  Title: Opportunity Subscription Number

  Maximum Length: 30

  The unique subscription number to associate a subscription with an opportunity.
• PrimaryFlag: boolean
  Title: Primary

  Indicates whether a subscription is the Primary Subscription associated with the opportunity.
• StartDate: string (date)
  Title: Subscription Start Date

  Read Only: true

  The start date of the subscription.
• Status: string
  Title: Subscription Status

  Read Only: true

  Maximum Length: 30

  The current status of the subscription.
• SubscriptionId: integer (int64)
  Title: Subscription ID

  The subscription associated with an opportunity.
• SubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  Maximum Length: 120

  The number assigned to the line within a subscription by the system or the customer.
• SubscriptionPeriod: string
  Title: Subscription Term

  The duration of the subscription.
• UpdateFlag: boolean
  Title: Updated

  Read Only: true

  Indicates whether the user has access to update the record.

{
    "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
        },
        "Status":{
            "title":"Subscription Status",
            "maxLength":"30",
            "type":"string",
            "description":"The current status of the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The number assigned to the line within a subscription by the system or the customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether a subscription is the Primary Subscription associated with the opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SubscriptionId"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The end date of the subscription.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Deleted",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriptionPeriod":{
            "title":"Subscription Term",
            "type":"string",
            "description":"The duration of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The start date of the subscription.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptySubscriptionId":{
            "title":"Opportunity Subscription ID",
            "type":"integer",
            "description":"The primary key and the unique internal identifier of the row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Updated",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NetPrice":{
            "title":"Total Contract Value",
            "type":"number",
            "description":"The total contract value of the subscription.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription ID",
            "type":"integer",
            "description":"The subscription associated with an opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency associated with the subscription.",
            "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 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
        },
        "OptySubscriptionNumber":{
            "title":"Opportunity Subscription Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique subscription number to associate a subscription with an opportunity.",
            "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 : opportunities-OpportunityTeam-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Read Only: true

  Maximum Length: 30

  The access level granted to the opportunity team member, manager, and administrator of the organizations in the resource hierarchy.
• AsgnTerrBasedInd: string
  Read Only: true

  Maximum Length: 1

  Indicates the territory is assigned using automatic territory-based assignment.
• AsgnTerritoryVersionId: integer (int64)
  Title: Territory

  Read Only: true

  Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  Indicates how the resource is added to the opportunity team, for example Ad-Hoc means resource is added manually or through rule-based assignment. Territory means resource is added through territory-based assignment.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the resource.
• ConflictId: integer (int64)
  Read Only: true

  Default Value: 0

  This value is used to guarantee the uniqueness of the row when duplicates are created in different databases, such as mobile databases or the server.
• 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 who created the opportunity resource record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time of the creation of the opportunity resource record.
• DealExpirationDate: string (date)
  Title: Deal Protected to Date

  Read Only: true

  The end date of the deal protection period of an opportunity team member. This date is set for members of territories that are removed from the opportunity because of territory realignment.
• DealProtectedDate: string (date)
  Title: Deal Protected from Date

  Read Only: true

  The start date of the deal protection period of an opportunity team member. This date is set for the members of territories that are removed from opportunity because of territory realignment.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The e-mail address of the resource.
• ForecastParticipationCode: string
  Title: Enable Forecasting

  Read Only: true

  Maximum Length: 30

  Default Value: REVENUE

  The forecast participation type of the territory.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The formatted phone number for the opportunity team member.
• FunctionCode: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The code of the function or role of the territory team member.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time of the last update of the opportunity resource record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the opportunity resource record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the opportunity resource record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LockAssignmentFlag: boolean
  Title: Lock Assignment

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether an opportunity team member can be removed from the team by automatic assignment.
• MemberFunctionCode: string
  Title: Function

  Read Only: true

  Maximum Length: 30

  The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.
• OptyId: integer (int64)
  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Read Only: true

  Maximum Length: 30

  The alternate unique identifier of the opportunity associated with the opportunity team.
• OptyResourceId: integer (int64)
  Title: Opportunity Resource ID

  Read Only: true

  The unique identifier of the opportunity resource.
• OptyResourceNumber: string
  Title: Opportunity Resource Number

  Read Only: true

  Maximum Length: 30

  The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).
• OptyTeamId: string
  Read Only: true

  Maximum Length: 255

  The unique key to identify the opportunity team member.
• OwnerFlag: boolean
  Title: Primary

  Read Only: true

  Indicates whether the opportunity team member is the owner of the opportunity.
• PartnerOrgId: integer (int64)
  Read Only: true

  The unique party identifier of the partner organization that the partner resource belongs to.
• PartnerPartyName: string
  Read Only: true

  Maximum Length: 360

  The name of the partner organization that the partner resource belongs to.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The full name of the opportunity team member.
• PersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the opportunity team member.
• PersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the opportunity team member.
• PrimaryPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The primary formatted phone number for the resource.
• ResourceId: integer (int64)
  The unique identifier of the resource.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The resource party number of the opportunity team member.
• RoleName: string
  Read Only: true

  Maximum Length: 255

  The role 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.
• TerritoryOwnerFlag: boolean
  Read Only: true

  Indicates whether the opportunity team member is the territory owner.
• TerritoryVersionId: integer (int64)
  The unique version identifier of the territory for the resource that got assigned to the opportunity 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 date and time of the creation of the opportunity resource record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The access level granted to the opportunity team member, manager, and administrator of the organizations in the resource hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The full name of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AsgnTerrBasedInd":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the territory is assigned using automatic territory-based assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases, such as mobile databases or the server.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealProtectedDate":{
            "title":"Deal Protected from Date",
            "type":"string",
            "description":"The start date of the deal protection period of an opportunity team member. This date is set for the members of territories that are removed from opportunity because of territory realignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerPartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner organization that the partner resource belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity team member is the territory owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyResourceNumber":{
            "title":"Opportunity Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyResourceId":{
            "title":"Opportunity Resource ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":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
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique party identifier of the partner organization that the partner resource belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The resource party number of the opportunity team member.",
            "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"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number for the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the opportunity associated with the opportunity team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the opportunity 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":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the opportunity team member is the owner of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the function or role of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the opportunity team member.",
            "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
        },
        "DealExpirationDate":{
            "title":"Deal Protected to Date",
            "type":"string",
            "description":"The end date of the deal protection period of an opportunity team member. This date is set for members of territories that are removed from the opportunity because of territory realignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":"30",
            "type":"string",
            "description":"The forecast participation type of the territory.",
            "nullable":true,
            "readOnly":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The role of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":"40",
            "type":"string",
            "description":"The primary formatted phone number for the resource.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "OptyTeamId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique key to identify the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"Indicates how the resource is added to the opportunity team, for example Ad-Hoc means resource is added manually or through rule-based assignment. Territory means resource is added through territory-based assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country code of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Lock Assignment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an opportunity team member can be removed from the team by automatic assignment.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "AsgnTerritoryVersionId":{
            "title":"Territory",
            "type":"integer",
            "description":"Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time of the last update of the opportunity resource record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the opportunity resource 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 : opportunities-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 unique identifier of the orchestration association.
• OrchestrationAssociationNumber: string
  Title: Orchestration Association Number

  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.
• 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/opportunities-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 alternate 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/opportunities-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/opportunities-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/opportunities-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/opportunities-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/opportunities-OrchestrationAssociations-StageObjectives-item-response"
            }
        },
        "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 : 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 opportunities-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/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-OrchestrationAssociations-StepTransitions-item-response"
    }
}

Nested Schema : opportunities-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 : opportunities-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 are to be executed or 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.
• 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 are to be executed or 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
        },
        "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 : opportunities-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

  The order in which the stage objectives are to be executed or 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":"The order in which the stage objectives are to be executed or 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 : opportunities-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

  The order in which the steps are to be executed or 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":"The order in which the steps are to be executed or 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 : opportunities-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 : opportunities-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 orchestration step transition runtime email type.
• 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 unique identifier of the orchestration step transition object.
• StepTransitionNumber: string
  Title: Step Transition Number

  Maximum Length: 64

  The alternate identifier of the orchestration step transition object.
• StepType: string
  Title: Step Type

  Maximum Length: 30

  The type of the step to which the step transitions correspond to.
• 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 orchestration step transition runtime email type.",
            "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 unique 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 alternate 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 the step to which the step transitions correspond to.",
            "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 : opportunities-RevenuePartnerPrimary-item-response

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the contact record was created.
• DealEstCloseDate: string (date-time)
  Title: Deal Registration Estimated Close Date

  The date when the deal registration is estimated to close.
• DealExpirationDate: string (date-time)
  Title: Expiration Date

  The date when the deal registration will expire.
• DealType: string
  Title: Type

  Maximum Length: 30

  The type of deal registration.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The number of the opportunity which is the unique public identifier of the opportunity.
• PartnerCompanyNumber: string
  Title: Partner Company Number

  Maximum Length: 30

  The alternate key identifier of the partner's company.
• PartnerPartyNumber: string
  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the partner party associated with the opportunity.
• PartOrgEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the primary partner organization for this revenue.
• PartOrgFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the primary partner organization for this revenue.
• PartOrgPartyId: integer (int64)
  Title: Name

  The unique identifier of the partner organization associated with the revenue.
• PartProgramId: integer (int64)
  Title: Program

  The unique identifier of the partner program associated with the revenue.
• PartTypeCd: string
  Title: Type

  Maximum Length: 30

  The code indicating the type of the party associated with the summary or primary revenue of the opportunity. A list of valid values is defined in the lookup PARTNER_PROFILE.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the partner party is associated with the opportunity.
• PartyName: string
  Title: Partner

  Maximum Length: 360

  The name of the partner party associated with the opportunity.
• PartyName1: string
  Title: Primary Resource

  Maximum Length: 360

  The name of the primary partner resource associated with the opportunity.
• PreferredContactEmail: string
  Title: Contact Email

  Read Only: true

  The preferred e-mail address of the partner???s primary contact.
• PreferredContactName: string
  Title: Primary Contact

  Read Only: true

  The preferred name of the partner???s primary contact.
• PreferredContactPhone: string
  Title: Contact Phone

  Read Only: true

  The preferred phone number of the partner???s primary contact.
• PrimaryFlg: string
  Title: Primary

  Indicates whether the Revenue Partner is the primary Revenue Partner for the opportunity.
• PrPartResourcePartyId: integer (int64)
  Title: Primary Resource

  The unique identifier of the primary partner resource.
• RegistrationNumber: string
  Title: Registration Number

  Maximum Length: 120

  The registration number of the deal registration.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 30

  The registration status of the partner who create the opportunity or deal.
• RevnId: integer (int64)
  The unique identifier of the summary or primary revenue for the opportunity.
• RevnPartnerNumber: string
  Title: Opportunity Partner Number

  Maximum Length: 30

  The party number of the partner record.
• RevnPartOrgPartyId: integer (int64)
  The unique identifier of the partner party associated with the opportunity.

{
    "type":"object",
    "properties":{
        "PartTypeCd":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the party associated with the summary or primary revenue of the opportunity. A list of valid values is defined in the lookup PARTNER_PROFILE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"PartyName"
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartOrgEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the primary partner organization for this revenue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "PreferredContactEmail":{
            "title":"Contact Email",
            "type":"string",
            "description":"The preferred e-mail address of the partner???s primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner party associated with the opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "PreferredContactName":{
            "title":"Primary Contact",
            "type":"string",
            "description":"The preferred name of the partner???s primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates whether the Revenue Partner is the primary Revenue Partner for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartOrgPartyId"
                ]
            }
        },
        "PartnerPartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the partner party associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName1":{
            "title":"Primary Resource",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the primary partner resource associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "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"
            }
        },
        "RegistrationNumber":{
            "title":"Registration Number",
            "maxLength":"120",
            "type":"string",
            "description":"The registration number of the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredContactPhone":{
            "title":"Contact Phone",
            "type":"string",
            "description":"The preferred phone number of the partner???s primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The number of the opportunity which is the unique public identifier of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealEstCloseDate":{
            "title":"Deal Registration Estimated Close Date",
            "type":"string",
            "description":"The date when the deal registration is estimated to close.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DealType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":"30",
            "type":"string",
            "description":"The registration status of the partner who create the opportunity or deal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartOrgFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the primary partner organization for this revenue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the deal registration will expire.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevnPartnerNumber":{
            "title":"Opportunity Partner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the partner record.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PartOrgPartyId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the partner organization associated with the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner party is associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the summary or primary revenue for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrPartResourcePartyId":{
            "title":"Primary Resource",
            "type":"integer",
            "description":"The unique identifier of the primary partner resource.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier of the partner program associated with the revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "Dependencies":"PartyName"
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the partner's company.",
            "nullable":false,
            "x-queryable":true
        },
        "RevnPartOrgPartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner party associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to 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 : opportunities-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 if 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 for smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether the smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Indicates whether the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  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/opportunities-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if 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/opportunities-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":"Indicates whether the action is seeded or custom.",
            "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/opportunities-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 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 for 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 opportunities-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/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : opportunities-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 : opportunities-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 : opportunities-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 : opportunities-winProbabilityDetails-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"
    }
}

Links

AiObjectHints

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/AiObjectHints

Parameters:

• OptyNumber: $request.path.OptyNumber

The object hints resource is used to view and update the AI object hints. It stores AI hint instances specific to an object along with user responses to the hints.

Assessments

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments

Parameters:

• OptyNumber: $request.path.OptyNumber

The assessments resource is used to view, create, update, and delete the assessment of an opportunity.

AssetVA

Operation: /crmRestApi/resources/11.13.18.05/assets

Assets represents the products owned by Customers. Anything tangible or intangible that is capable of being owned or controlled to produce value. For example: Tangible Items - Computers, engines, machine parts, and so on. Intangible items - Software, Services, Licenses and agreements

AssignmentModeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{AssignmentMode}%2CBindLookupType%3DORA_MOO_OPTY_ASGN_MODE_OPTIONS

The lookups resource is used to view standard lookup codes.

Attachment

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Attachment

Parameters:

• OptyNumber: $request.path.OptyNumber

The attachments resource is used to view, create, update, and delete attachments of an opportunity. An attachment includes additional information about an opportunity.

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.

ChildRevenue

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue

Parameters:

• OptyNumber: $request.path.OptyNumber

The revenue items resource is used to view, create, update, and delete the revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing.

ClosePeriodLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_CLS_PERIOD

The lookups resource is used to view standard lookup codes.

CustomerAccountPickerVO

Operation: /crmRestApi/resources/11.13.18.05/accounts

An account for a customer or prospect. This object is an aggregation of primary account profile, and contact information, and references a single primary address.

ForecastCategoryVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ForecastCategory}%2CBindLookupType%3DORA_MOO_FORECAST_CATEGORY_TYPE

The lookups resource is used to view standard lookup codes.

FrcstOverrideCodeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZSF_FCST_INCLUDE_IN_FCST%2CBindLookupCode%3D{ForecastOverrideCode}

The lookups resource is used to view standard lookup codes.

Interviews

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews

Parameters:

• OptyNumber: $request.path.OptyNumber

The interviews resource is used to view the list of interviews related to the opportunities.

LobForSearchLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_LINE_OF_BUSINESS%2CBindLookupCode%3D{LineOfBusinessCode}

The lookups resource is used to view standard lookup codes.

Note

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note

Parameters:

• OptyNumber: $request.path.OptyNumber

The note resource is used to view, create, update, and delete notes associated with an opportunity. A note captures comments, information, or instructions related to an opportunity.

OpportunityCampaigns

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCampaigns

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity campaigns resource is used to view, create, update, and delete campaigns associated with an opportunity.

OpportunityCompetitor2

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityCompetitor2

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity competitors resource is used to view, create, update, and delete the competitors for an opportunity.

OpportunityContact

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity contacts resource is used to view, create, update, and delete the contacts of an opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.

OpportunityDeal

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity deals resource is used to view the deals associated with an opportunity.

OpportunityLead

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityLead

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity leads resource is used to view, create, update, and delete the leads that resulted in an opportunity.

OpportunityOriginVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{OpportunityOrigin}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_ORIGIN

The lookups resource is used to view standard lookup codes.

OpportunityResource

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityResource

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity team members resource is used to view, create, update, and delete the team members associated with an opportunity.

OpportunityRollup

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityRollup

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity rollups resource is used to view an opportunity rollup.

OpportunitySource1

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySource1

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity sources resource is used to view, create, update, and delete the source of an opportunity. The opportunity source is the marketing or sales campaign that resulted in the opportunity.

OpportunitySubscription

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunitySubscription

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity subscriptions resource is used to view the aggregate of all revenue subscriptions to the opportunity level.

OpportunityTeam

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityTeam

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity teams resource is used to view the team members and territory team members associated with an opportunity.

OpportunityTypePVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{OpportunityTypeCode}%2CBindLookupType%3DORA_MOO_OPPORTUNITY_TYPE

The lookups resource is used to view standard lookup codes.

OptyDealHorizonLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_DEAL_HORIZION%2CpReferenceGroupName%3DMOO_SETID_DEAL_HORIZION%2CpEnabledFlag%3DY

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

OptyDecisionLevelLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_DECISION_LEVEL%2CpReferenceGroupName%3DMOO_SETID_DECISION_LEVEL%2CpEnabledFlag%3DY

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

OptyRenewalProcessPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RenewalProcess}%2CBindLookupType%3DORA_MOO_OPTY_RENEWAL_PROCESS

The lookups resource is used to view standard lookup codes.

OptyRiskLevelLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_RISK_LEVEL%2CpReferenceGroupName%3DMOO_SETID_RISK_LEVEL%2CpEnabledFlag%3DY

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

OptyStatusCategoryLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DZBS_SALESLOOKUPS_CATEGORY

The lookups resource is used to view standard lookup codes.

OptyStatusZbsValuesLOV

Operation: /crmRestApi/resources/11.13.18.05/optyStatusesLOV

Parameters:

• finder: StatusByBUIdFinder%3BBindEnabledFlag%3DY%2CBindLookupType%3DOPTY_STATUS%2CBindBUId%3D{PrimaryOrganizationId}

The configurable setup data defined specifically for sales usage.

OptyStrategicValueLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpLookupType%3DMOO_SETID_STRATEGIC_VALUE%2CpReferenceGroupName%3DMOO_SETID_STRATEGIC_VALUE%2CpEnabledFlag%3DY

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

OrchestrationAssociations

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations

Parameters:

• OptyNumber: $request.path.OptyNumber

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

PartnerPickerVA

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

Parameters:

• finder: ActivePartnersFinder%3BBindDefaultStatus%3DACTIVE%2CBindExtraStatus%3DACTIVE

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

RatedCurrenciesVO

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.

ReasonWonLostLOV

Operation: /crmRestApi/resources/11.13.18.05/fndCommonSetIdLookups

Parameters:

• finder: CommonSetIdWithBUIdFinder%3BpBusinessUnitId%3D{PrimaryOrganizationId}%2CpEnabledFlag%3DY%2CpLookupType%3DMOO_SETID_WIN_LOSS_REASON%2CpReferenceGroupName%3DMOO_SETID_WIN_LOSS_REASON

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

RegisteredLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_DEAL_REGISTERED_FLAG

The lookups resource is used to view standard lookup codes.

RegistrationStatusLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The lookups resource is used to view standard lookup codes.

RegistrationTypeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DPARTNER_REGISTRATION_INITIATOR%2CBindLookupCode%3D{RegistrationType}

The lookups resource is used to view standard lookup codes.

RevenuePartnerPrimary

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/RevenuePartnerPrimary

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity partner resource is used to view, create, update, and delete the partners associated with an opportunity. An opportunity partner contributes to the selling effort of an opportunity.

RevenueSalesChannelLookupVO

Operation: /crmRestApi/resources/11.13.18.05/revenueSalesChannels

Parameters:

• finder: SalesChannelFinder%3BBindLookupCode%3DZPM_PARTNER_CHANNEL_TYPES%2CBindLookupType%3DZPM_SALES_CHANNEL

The resource is used to view the values for sales channels of opportunity revenue.

SalesMethodLOV

Operation: /crmRestApi/resources/11.13.18.05/salesMethodsLOV

Parameters:

• finder: SalesMethodByBUFinder%3BBindBUId%3D{PrimaryOrganizationId}%2CBindOpportunityType%3D{OpportunityTypeCode}

A sales method is an approach used in the sales process. A method can encompass every stage associated with the sales process, from prospecting to forecasting to closing opportunities.

SalesStageLOV

Operation: /crmRestApi/resources/11.13.18.05/salesStagesLOV

Parameters:

• finder: SalesStageBySalesMethodFinder%3BBindSalesMethodId%3D{SalesMethodId}

The sales stage for a given sales method describes the progress of an opportunity in the sales cycle.

SearchFilteringLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DMOO_OPTY_SRCH_RECORD_SET

The lookups resource is used to view standard lookup codes.

YesNoLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

opportunityStageSnapshots

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshots

Parameters:

• OptyNumber: $request.path.OptyNumber

The opportunity stage snapshots is used to view all the historical snapshots of the opportunity.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/smartActions

Parameters:

• OptyNumber: $request.path.OptyNumber

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.

winProbabilityDetails

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/winProbabilityDetails

Parameters:

• OptyNumber: $request.path.OptyNumber

The win probability details resource is used to view the details of the winning probability of an opportunity.

Back to Top

Examples

The following example shows how to create an opportunity by submitting a post request on the REST resource using cURL. For more information about cURL, see Use cURL.

cURL Command

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

Note:

You can create an opportunity with an asset through the POST method. When you create an opportunity with an asset using REST API, the account details are populated from the account related to the asset. You need to create an account before creating an opportunity.

Example of Request Body

The following shows an example of the request body in JSON format.

Content-Type: {
"Name" : "Major Application Upgrade"
}

Example of Response Body

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

Content-Type: {
BudgetAvailableDate: null
BudgetedFlag: false
PrimaryOrganizationId: 204
ChampionFlag: false
CreatedBy: "SALES_ADMIN"
CreationDate: "2015-06-04T03:08:27-07:00"
CurrencyCode: "USD"
SalesMethodId: 100000012430001
SalesStageId: 100000012430007
Name: "Major Application Upgrade"
OptyId: 300100111705686
OptyNumber: "CDRM_332708"
OwnerResourcePartyId: 3807
StatusCode: "OPEN"
PrimaryRevenueId: 300100111705687
SalesMethod: "Standard Sales Process"
SalesStage: "01 - Qualification"
DescriptionText: "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor"
AverageDaysAtStage: 30
MaximumDaysInStage: 800
PhaseCd: "QUALIFICATION-DISCOVERY"
QuotaFactor: 3
RcmndWinProb: 0
StageStatusCd: "OPEN"
StgOrder: 1
EffectiveDate: "2015-06-24"
Revenue: 0
WinProb: 0
PartyName1: "Charles Taylor"
DownsideAmount: 0
UpsideAmount: 0
EmailAddress: "[e-mail]"
ExpectAmount: 0
ForecastOverrideCode: "CRITERIA"
SalesChannelCd: "ZPM_DIRECT_CHANNEL_TYPES"
...
}

Example - Example- Create Multiple Revenue Lines For an Existing Opportunity

The following example shows how to create multiple revenue lines for an existing opportunity.

Example of Request Body

The following shoes an example of the request body in JSON format.

{
  "parts": [
  {
  "id": "part1",
  "path": "opportunities/CDRM_107474/child/ChildRevenue",
  "operation": "create",
  "payload": {
   "ProdGroupId": 999997826071065,
"UnitPrice": 600,
"Quantity": 2
  }
  },
  {
  "id": "part2",
  "path": "opportunities/CDRM_107474/child/ChildRevenue ",
  "operation": "create",
  "payload": {
 "ProdGroupId": 999997826071065,
"UnitPrice": 700,
"Quantity": 3
  }
  }
  ]
}

In the above sample payload, CDRM_107474 is the opty number.

Example of Response Body

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

{
"parts": [
{
"id": "part1",
  "path": "opportunities/CDRM_107474/child/ChildRevenue",
  "operation": "create",
"payload" : {
{
RevnId: 300100111705696
BUOrgId: 204
CommitFlag: false
CostAmount: 0
ResourcePartyId: 100010025532672
DownsideAmount: 0
ExpectAmount: 0
MarginAmount: 0
OptyId: 300100111705686
RevnAmount: 400
RevnAmountCurcyCode: "USD"
UpsideAmount: 0
WinProb: 0
PrimaryFlag: false
...
}
},
},
{
"id": "part2",
"path": "opportunities/CDRM_107474/child/ChildRevenue",
"operation": "create",
"payload" : {
RevnId: 300100111705697
BUOrgId: 204
CommitFlag: false
CostAmount: 0
ResourcePartyId: 100010025532672
DownsideAmount: 0
ExpectAmount: 0
MarginAmount: 0
OptyId: 300100111705686
RevnAmount: 400
RevnAmountCurcyCode: "USD"
UpsideAmount: 0
WinProb: 0
PrimaryFlag: false
...
}
}

...
}
}
]
}

Create an Opportunity With Multiple Revenue Lines

The following example shows how to create a new opportunity with multiple revenue lines.

Example of Request Body

The following shows an example of the request body in JSON format.

Request
{
 "Name": "Pinnacle Server Opportunities",
  "ChildRevenue":
[
  {
 "ProdGroupId": 999997826071065,
"UnitPrice": 100,
"Quantity": 1
},
{
"ProdGroupId": 999997826071065,
 "UnitPrice": 100,
 "Quantity": 1
}
]
}

Example of Response Body

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

{
BudgetAvailableDate: null
BudgetedFlag: false
PrimaryOrganizationId: 204
ChampionFlag: false
CreatedBy: "SALES_ADMIN"
CreationDate: "2015-06-04T03:08:27-07:00"
CurrencyCode: "USD"
SalesMethodId: 100000012430001
SalesStageId: 100000012430007
Name: "Pinnacle Server Opportunities"
OptyId: 300100111705686
OptyNumber: "CDRM_332708"
OwnerResourcePartyId: 3807
StatusCode: "OPEN"
PrimaryRevenueId: 300100111705687
SalesMethod: "Standard Sales Process"
SalesStage: "01 - Qualification"
...
"ChildRevenue": [
    {
      "RevnId": 300100182390421,
      "TargetPartyId": null,
      "CustomerAccountId": null,
      "BUOrgId": 204,
      "Comments": null,
      "CommitFlag": false,
      "OptyEffectiveDate": "2019-12-25",
      "CostAmount": 0,
      "ResourcePartyId": 100010025532672,
      "DownsideAmount": 0,
      "ExpectAmount": 0,
      "MarginAmount": 0,
      "OptyId": 300100182390419,
      "UnitPrice": 100,
      "InventoryItemId": null,
      "InventoryOrgId": null,
      "Quantity": 1,
      "Discount": null,
      "RevnAmount": 100,
      "RevnAmountCurcyCode": "USD",
      "TypeCode": null,
      "UpsideAmount": 100,
      "WinProb": 0,
      "UOMCode": null,
      
     ...
    },
    {
      "RevnId": 300100182390422,
      "TargetPartyId": null,
      "CustomerAccountId": null,
      "BUOrgId": 204,
      "Comments": null,
      "CommitFlag": false,
      "OptyEffectiveDate": "2019-12-25",
      "CostAmount": 0,
      "ResourcePartyId": 100010025532672,
      "DownsideAmount": 0,
      "ExpectAmount": 0,
      "MarginAmount": 0,
      "OptyId": 300100182390419,
      "UnitPrice": 100,
      "InventoryItemId": null,
      "InventoryOrgId": null,
      "Quantity": 1,
      "Discount": null,
      "RevnAmount": 100,
      "RevnAmountCurcyCode": "USD",
      "TypeCode": null,
      "UpsideAmount": 100,
      "WinProb": 0,
      "UOMCode": null,
      
      ...
    }
  ]
}

Create an Opportunity with Attachments

The following example shows how to create an opportunity with attachments.

cURL Command

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

Example of Request Body

The following shows the contents of the request body in JSON format.

{
           "Name": "TEST SR 20210210",
           "Attachment":
           [
           {
           "FileName":"sample.txt",
           "UploadedFileLength":4,
           "UploadedFileContentType":"text/plain",
            "FileContents":"VGVzdA=="
            }
            ]
}

Example of Response Body

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

{
    "BudgetAvailableDate": null,
    "BudgetedFlag": false,
    "PrimaryOrganizationId": 204,
    "ChampionFlag": false,
    "ConflictId": 0,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2021-03-19T06:34:14+00:00",
    "CurrencyCode": "USD",
    "OpportunityTypeCode": null,
    "RenewalProcess": null,
    "SalesMethodId": 100000012430001,
    "SalesStageId": 100000012430007,
    "CustomerAccountId": null,
    "DealHorizonCode": null,
    "DecisionLevelCode": null,
    "Description": null,
    "LastUpdateDate": "2021-03-19T06:34:26.406+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateLogin": "BDC077D42CC4F517E0531A6CF00A753E",
    "Name": "TEST SR 20210210",
    "OptyId": 300100545738141,
    "OptyNumber": "CDRM_132411",
    "OwnerResourcePartyId": 100010025532672,
    "PrimaryCompetitorId": null,
    "KeyContactId": null,
    "ReasonWonLostCode": null,
    "RiskLevelCode": null,
    "StatusCode": "OPEN",
    "StrategicLevelCode": null,
    "PrimaryRevenueId": 300100545738142,
    "TargetPartyId": null,
    "TargetPartyName": null,
    "SalesMethod": "Standard Sales Process",
    "SalesStage": "01 - Qualification",
    "DescriptionText": "Looking for the Right Contacts, Characteristics, Determining the Need, Budget and Sponsor",
    "AverageDaysAtStage": 30,
    "MaximumDaysInStage": 800,
    "PhaseCd": "QUALIFICATION-DISCOVERY",
    "QuotaFactor": 3,
    "RcmndWinProb": 0,
    "StageStatusCd": "OPEN",
    "StgOrder": 1,
    "EffectiveDate": "2021-04-08",
    "Revenue": 0,
    "WinProb": 0,
    "SourceType": "OPPORTUNITY",
    "PrimaryContactPartyName": null,
    "PrimaryContactFormattedPhoneNumber": null,
    "PrimaryContactEmailAddress": null,
    "BdgtAmount": null,
    "BdgtAmtCurcyCd": null,
    "Comments": null,
    "PartyName1": "Gabrielle   Lee",
    "PrSrcNumber": null,
    "DownsideAmount": 0,
    "UpsideAmount": 0,
    "EmailAddress": "[e-mail]",
    "LookupCategory": "OPEN",
    "OptyCreationDate": "2021-03-19T06:34:14+00:00",
    "ExpectAmount": 0,
    "OptyCreatedBy": "SALES_ADMIN",
    "CrmConversionRate": 1,
    "ForecastOverrideCode": "CRITERIA",
    "OptyLastUpdateDate": "2021-03-19T06:34:14.002+00:00",
    "OptyLastUpdatedBy": "SALES_ADMIN",
    "SalesChannelCd": "ZPM_DIRECT_CHANNEL_TYPES",
    "LineOfBusinessCode": null,
    "PartyUniqueName1": null,
    "BatchTag": null,
    "SalesAccountUniqueName": null,
    "PrimaryPartnerOrgPartyName": null,
    "PrimaryPartnerId": null,
    "RegistrationStatus": null,
    "RegistrationType": null,
    "RecordSet": null,
    "Registered": "NO",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "Selected": null,
    "AssetNumber": null,
    "AssetId": null,
    "AssetProduct": null,
    "AssetSerialNumber": null,
    "ClosePeriod": null,
    "PredWinProb": null,
    "HintCode": null,
    "RecommendedAction": null,
    "OwnerPartyNumber": "100010025532672",
    "AccountPartyNumber": null,
    "PrimaryCompetitorPartyNumber": null,
    "PrimaryContactPartyNumber": null,
    "PrimaryPartnerCompanyNumber": null,
    "QuotedFlag": false,
    "CrmCurrencyCode": "USD",
    "IBAssetId": null,
    "IBAssetNumber": null,
    "IBAssetSerialNumber": null,
    "TargetPartyPrimaryAddressCountry": null,
    "Attachment": {
        "items": [
            {
                "AttachedDocumentId": 300100545738144,
                "LastUpdateDate": "2021-03-19T06:34:31.719+00:00",
                "LastUpdatedBy": "SALES_ADMIN",
                "DatatypeCode": "FILE",
                "FileName": "sample.txt",
                "DmFolderPath": null,
                "DmDocumentId": "UCMFA00103557",
                "DmVersionNumber": "103788",
                "Url": null,
                "CategoryName": "MISC",
                "UserName": null,
                "Uri": null,
                "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a103788?XFND_SCHEME_ID=1&XFND_VERT_FP=E6F3E0C26780D902815B9D7D2CE31EA602A2959F&XFND_RANDOM=-5444935521682048750&XFND_EXPIRES=1616136271546&XFND_SIGNATURE=QksWlaWGnxKt2Q7ClFVyhkr6YzAWMtnn24Lh0S~67Bi-E9EIbtSviNfp7~eXe3FO39biD5u9XRBSnF4S7WowS9svHui-GQqDJE3UR1Jpz1O3~Gg8pTbRI0pOhH25NxZM9FKIC4kAg9ek~11rZdKbS8xDcDapkUpclfEZ8vgMgxlH7moSQbLkMX4Tecl17PIjD56d866vn~yrRJgiUtdMrtSwfkTP023lJajnGPwK2lc0B8LDz3s5V0OPe9kqR2Zs9Zpa5C-0eUO-o9cthNmNrT-EG9oT6TJAQL9yYDTByo-5Hv3dLwuc3~4OsgHlbpKYVVXecljp21-2KutyaZxvYA__&Id=103788&download",
                "UploadedText": null,
                "UploadedFileContentType": "text/plain",
                "UploadedFileLength": 4,
                "UploadedFileName": "sample.txt",
                "ContentRepositoryFileShared": "false",
                "Title": "sample.txt",
                "Description": "",
                "ErrorStatusCode": null,
                "ErrorStatusMessage": null,
                "CreatedBy": "SALES_ADMIN",
                "CreationDate": "2021-03-19T06:34:22.342+00:00",
                "ExpirationDate": null,
                "LastUpdatedByUserName": "Gabrielle Lee",
                "CreatedByUserName": "Gabrielle Lee",
                "AsyncTrackerId": null,
                "links": [

...
}

Back to Top