Get an opportunity
get
/services/rest/connect/v1.4/opportunities/{id}
Request
Path Parameters
-
id: integer
The unique identifier of the opportunity.
Response
Default Response
Root Schema : opportunities
Type:
object
The information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base.
Show Source
-
accountHierarchy(optional):
array accountHierarchy
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resources.
-
assignedToAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
banner(optional):
object opportunities-banner
The display flags of a banner.
-
campaign(optional):
[
"object",
"null"
]
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. It is the reference to a resource in 'campaigns' collection. Only ID or lookupName can be provided to specify the resource.
-
closedTime(optional):
[
"string",
"null"
]
The date and time when the opportunity was closed.
-
closedValue(optional):
object opportunities-closedValue
The monetary value that consists of currency, exchange rate, and value.
-
costOfSale(optional):
object opportunities-costOfSale
The monetary value that consists of currency, exchange rate, and value.
-
createdTime(optional):
string
The date and time when the opportunity was created. This attribute is read-only.
-
fileAttachments(optional):
object opportunities-fileAttachments
The file attachment that includes additional fields used for attachments to various classes.
-
forecastCloseDate(optional):
[
"string",
"null"
]
The date when the opportunity is estimated to close.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the opportunity. -
initialContactDate(optional):
[
"string",
"null"
]
The date when the sales representative made the initial contact with the organization.
-
interface(optional):
object interface
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
leadRejectDateTime(optional):
[
"string",
"null"
]
The date and time when the lead was rejected.
-
leadRejectDescription(optional):
[
"string",
"null"
]
Maximum Length:
1333
The summary or description provided when the lead was rejected. -
leadRejectReason(optional):
object namedIDs-opportunities-leadRejectReason
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
lookupName(optional):
string
Maximum Length:
255
The name used to look up the opportunity. -
lostTime(optional):
[
"string",
"null"
]
The date and time when the opportunity was lost.
-
managerCommit(optional):
boolean
The committed status of the manager-forecasted value. The default value is false.
-
managerValue(optional):
object opportunities-managerValue
The monetary value that consists of currency, exchange rate, and value.
-
name(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The name of the opportunity. -
notes(optional):
object opportunities-notes
The note text associated with the objects such as contacts and organizations.
-
organization(optional):
[
"object",
"null"
]
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
-
otherContacts(optional):
object opportunities-otherContacts
The secondary contact associated with the opportunity.
-
primaryContact(optional):
object opportunities-primaryContact
The primary contact associated with an opportunity.
-
quotes(optional):
object opportunities-quotes
The sales quote associated with an opportunity.
-
recallTime(optional):
[
"string",
"null"
]
The date and time when the opportunity was recalled.
-
returnValue(optional):
object opportunities-returnValue
The monetary value that consists of currency, exchange rate, and value.
-
salesRepresentativeCommit(optional):
boolean
Indicates whether the sales representative-forecasted value is committed. The default value is false.
-
salesRepresentativeValue(optional):
object opportunities-salesRepresentativeValue
The monetary value that consists of currency, exchange rate, and value.
-
source(optional):
object namedIDHierarchies-opportunities-source
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
stageWithStrategy(optional):
object opportunities-stageWithStrategy
The stage an opportunity has reached within a sales strategy.
-
statusWithType(optional):
object opportunities-statusWithType
The status of an object with its associated status type.
-
summary(optional):
[
"string",
"null"
]
Maximum Length:
1333
The brief summary of the opportunity. -
survey(optional):
object namedIDs-opportunities-survey
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
territory(optional):
[
"object",
"null"
]
The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. It is the reference to a resource in 'salesTerritories' collection. Only ID or lookupName can be provided to specify the resource.
-
territoryHierarchy(optional):
array territoryHierarchy
The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. It is the reference to a resource in 'salesTerritories' collection. Only ID or lookupName can be provided to specify the resources.
-
updatedTime(optional):
string
The date and time when the opportunity was last updated. This attribute is read-only.
-
winLossDescription(optional):
[
"string",
"null"
]
Maximum Length:
1333
The description of how the opportunity was won or lost. -
winLossReason(optional):
object namedIDs-opportunities-winLossReason
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : accountHierarchy
Type:
array
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : opportunities-closedValue
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-closedValue-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-closedValue-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-costOfSale
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-costOfSale-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-costOfSale-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-fileAttachments
Type:
object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
-
contentType(optional):
string
Maximum Length:
128
Pattern:^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$
The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. -
createdTime(optional):
string
The date and time when the file was associated with the object. This attribute is read-only.
-
data(optional):
string
The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
-
description(optional):
string
Maximum Length:
1333
The description for the contents of the file attachment. -
fileName(optional):
string
Maximum Length:
100
Pattern:^[^ \/:*?"<>|]*$
The name of the file when saving it to the disk. -
formData(optional):
string
The HTML form which is used to upload file attachments.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the file attachment. -
name(optional):
string
Maximum Length:
40
Pattern:^[^ ]*$
The short display name of the file attachment. -
size(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The size of the file in bytes. This attribute is read-only. -
updatedTime(optional):
[
"string",
"null"
]
The date and time when the file attachment was last updated. This attribute is read-only.
-
uRL(optional):
string
Maximum Length:
1333
The URL to access this file.
Nested Schema : interface
Type:
object
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-opportunities-leadRejectReason
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : opportunities-managerValue
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-managerValue-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-managerValue-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-notes
Type:
object
The note text associated with the objects such as contacts and organizations.
Show Source
-
channel(optional):
object namedIDs-opportunities-notes-channel
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
createdByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the note was created. This attribute is read-only.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the note. -
text(optional):
string
Maximum Length:
349525
The text content in the note. -
updatedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime(optional):
string
The date and time when the note was last updated. This attribute is read-only.
Nested Schema : opportunities-otherContacts
Type:
object
The secondary contact associated with the opportunity.
Show Source
-
contact(optional):
object contact
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
contactRole(optional):
object namedIDs-opportunities-otherContacts-contactRole
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : opportunities-primaryContact
Type:
object
The primary contact associated with an opportunity.
Show Source
-
contact(optional):
object contact
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
contactRole(optional):
object namedIDs-opportunities-primaryContact-contactRole
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : opportunities-quotes
Type:
object
The sales quote associated with an opportunity.
Show Source
-
adjustedTotal(optional):
object opportunities-quotes-adjustedTotal
The monetary value that consists of currency, exchange rate, and value.
-
comment(optional):
[
"string",
"null"
]
Maximum Length:
1333
The comment text for the quote. -
createdTime(optional):
string
The date and time when the quote was created.
-
discountPercent(optional):
integer
Minimum Value:
0
Maximum Value:100
The discount percentage for the quote. -
fileAttachments(optional):
object opportunities-quotes-fileAttachments
The file that is attached or associated with another object.
-
forecasted(optional):
boolean
Indicates whether the quote has been forecasted. The default value is false.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the quote. This is the key for the list entry. -
lineItems(optional):
object opportunities-quotes-lineItems
The product line item in a quote.
-
name(optional):
string
Maximum Length:
40
Pattern:^[^ ]*$
The descriptive name of the quote. -
offerEndTime(optional):
[
"string",
"null"
]
The date and time when the quoted offer ends.
-
offerStartTime(optional):
[
"string",
"null"
]
The date and time when the quoted offer starts.
-
priceSchedule(optional):
object namedIDs-opportunities-quotes-priceSchedule
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
sentTime(optional):
[
"string",
"null"
]
The date and time when the quote was sent.
-
sentTo(optional):
[
"string",
"null"
]
Maximum Length:
1333
The email addresses of the contact to whom the quote was sent. This attribute is read-only. -
status(optional):
object namedIDs-opportunities-quotes-status
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
template(optional):
object namedIDs-opportunities-quotes-template
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
total(optional):
object opportunities-quotes-total
The monetary value that consists of currency, exchange rate, and value.
-
updatedTime(optional):
string
The date and time when the quote was last updated. This attribute is read-only.
Nested Schema : opportunities-returnValue
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-returnValue-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-returnValue-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-salesRepresentativeValue
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-salesRepresentativeValue-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-salesRepresentativeValue-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : namedIDHierarchies-opportunities-source
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
1
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object -
parents(optional):
object namedIDHierarchies-opportunities-source-parents
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Nested Schema : opportunities-stageWithStrategy
Type:
object
The stage an opportunity has reached within a sales strategy.
Show Source
-
stage(optional):
object namedIDs-opportunities-stageWithStrategy-stage
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
strategy(optional):
object namedIDs-opportunities-stageWithStrategy-strategy
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : opportunities-statusWithType
Type:
object
The status of an object with its associated status type.
Show Source
-
status(optional):
object namedIDs-opportunities-statusWithType-status
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
statusType(optional):
object namedIDs-opportunities-statusWithType-statusType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : namedIDs-opportunities-survey
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : territoryHierarchy
Type:
array
The specific geographical sales region. Sales representatives can be assigned specific territories for opportunity assignment. It is the reference to a resource in 'salesTerritories' collection. Only ID or lookupName can be provided to specify the resources.
Show Source
Nested Schema : namedIDs-opportunities-winLossReason
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : items
Type:
object
Nested Schema : namedIDs-opportunities-closedValue-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-closedValue-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-costOfSale-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-costOfSale-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-managerValue-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-managerValue-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-notes-channel
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : contact
Type:
object
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-opportunities-otherContacts-contactRole
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : contact
Type:
object
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-opportunities-primaryContact-contactRole
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : opportunities-quotes-adjustedTotal
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-quotes-adjustedTotal-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-quotes-adjustedTotal-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-quotes-fileAttachments
Type:
object
The file that is attached or associated with another object.
Show Source
-
contentType(optional):
string
Maximum Length:
128
Pattern:^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$
The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. -
createdTime(optional):
string
The date and time when the file was associated with the object. This attribute is read-only.
-
data(optional):
string
The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
-
fileName(optional):
string
Maximum Length:
100
Pattern:^[^ \/:*?"<>|]*$
The name of the file when saving it to the disk. -
formData(optional):
string
The HTML form which is used to upload file attachments.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the file attachment. -
size(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The size of the file in bytes. This attribute is read-only. -
updatedTime(optional):
[
"string",
"null"
]
The date and time when the file was last updated. This attribute is read-only.
-
uRL(optional):
string
Maximum Length:
1333
The URL to access the file.
Nested Schema : opportunities-quotes-lineItems
Type:
object
The product line item in a quote.
Show Source
-
adjustedDescription(optional):
[
"string",
"null"
]
Maximum Length:
1333
The edited product description in the product line item. -
adjustedName(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The edited product name in the product line item. -
adjustedPartNumber(optional):
[
"string",
"null"
]
Maximum Length:
40
Pattern:^[^ ^|]*$
The edited product part number in the product line item. -
adjustedPrice(optional):
object opportunities-quotes-lineItems-adjustedPrice
The monetary value that consists of currency, exchange rate, and value.
-
adjustedTotal(optional):
object opportunities-quotes-lineItems-adjustedTotal
The monetary value that consists of currency, exchange rate, and value.
-
comment(optional):
[
"string",
"null"
]
Maximum Length:
1333
The comments associated with a product line item in the quote. -
discountPercent(optional):
integer
Minimum Value:
0
Maximum Value:100
The discount applied to the adjusted price of the product line item. -
displayOrder(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The position of the line item in the quote. -
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the product line item in the quote. This is the key for the list entry. -
originalDescription(optional):
[
"string",
"null"
]
Maximum Length:
1333
The original product description. This attribute is read-only. -
originalName(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The original product name. This attribute is read-only. -
originalPartNumber(optional):
[
"string",
"null"
]
Maximum Length:
40
Pattern:^[^ ^|]*$
The original product part number. This attribute is read-only. -
originalPrice(optional):
object opportunities-quotes-lineItems-originalPrice
The monetary value that consists of currency, exchange rate, and value.
-
product(optional):
[
"object",
"null"
]
The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource.
-
quantity(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The product quantity in the line item.
Nested Schema : namedIDs-opportunities-quotes-priceSchedule
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-status
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-template
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : opportunities-quotes-total
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-quotes-total-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-quotes-total-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : namedIDs-opportunities-quotes-adjustedTotal-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-adjustedTotal-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : opportunities-quotes-lineItems-adjustedPrice
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-quotes-lineItems-adjustedPrice-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-quotes-lineItems-adjustedPrice-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-quotes-lineItems-adjustedTotal
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-quotes-lineItems-adjustedTotal-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-quotes-lineItems-adjustedTotal-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : opportunities-quotes-lineItems-originalPrice
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency(optional):
object namedIDs-opportunities-quotes-lineItems-originalPrice-currency
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
exchangeRate(optional):
object namedIDs-opportunities-quotes-lineItems-originalPrice-exchangeRate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
value(optional):
number
The value of the currency.
Nested Schema : namedIDs-opportunities-quotes-lineItems-adjustedPrice-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-lineItems-adjustedPrice-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-lineItems-adjustedTotal-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-lineItems-adjustedTotal-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-lineItems-originalPrice-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-lineItems-originalPrice-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-total-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-quotes-total-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-returnValue-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-returnValue-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-salesRepresentativeValue-currency
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-salesRepresentativeValue-exchangeRate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDHierarchies-opportunities-source-parents
Type:
object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
-
id(optional):
integer
Minimum Value:
1
ID value. Read-only -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-stageWithStrategy-stage
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-stageWithStrategy-strategy
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-statusWithType-status
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-opportunities-statusWithType-statusType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : items
Type:
object
Examples
Use GET with the following syntax to retrieve a specific opportunity:
https://your_site_interface/services/rest/connect/version/opportunities/2
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/opportunities/2
Response body example
{
"id": 2,
"lookupName": "Systems Partners",
"createdTime": "2015-12-01T20:46:49.000Z",
"updatedTime": "2015-12-01T20:46:49.000Z",
"accountHierarchy": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2/accountHierarchy"
}
]
},
"assignedToAccount": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/3"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/3"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
"mediaType": "application/schema+json"
}
]
},
"banner": {
"importanceFlag": null,
"text": null,
"updatedByAccount": null,
"updatedTime": null
},
"closedTime": null,
"closedValue": {
"currency": {
"id": 1,
"lookupName": "USD"
},
"exchangeRate": null
},
"costOfSale": {
"currency": null,
"exchangeRate": null
},
"customFields": {
"c": {}
},
"fileAttachments": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2/fileAttachments"
}
]
},
"forecastCloseDate": null,
"initialContactDate": null,
"interface": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/siteInterfaces/1"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/siteInterfaces",
"mediaType": "application/schema+json"
}
]
},
"leadRejectDateTime": null,
"leadRejectDescription": null,
"leadRejectReason": null,
"lostTime": null,
"managerCommit": false,
"managerValue": {
"currency": {
"id": 1,
"lookupName": "USD"
},
"exchangeRate": null
},
"name": "Systems Partners",
"notes": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2/notes"
}
]
},
"organization": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/15"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/15"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/organizations",
"mediaType": "application/schema+json"
}
]
},
"otherContacts": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2/otherContacts"
}
]
},
"primaryContact": null,
"quotes": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2/quotes"
}
]
},
"recallTime": null,
"returnValue": {
"currency": null,
"exchangeRate": null
},
"salesRepresentativeCommit": false,
"salesRepresentativeValue": {
"currency": {
"id": 1,
"lookupName": "USD"
},
"exchangeRate": null
},
"source": {
"id": 1004,
"lookupName": "Opportunity Editor",
"parents": [
{
"id": 32002,
"lookupName": "CX Console"
}
]
},
"stageWithStrategy": {
"stage": null,
"strategy": null
},
"statusWithType": {
"status": {
"id": 9,
"lookupName": "Active"
},
"statusType": {
"id": 6,
"lookupName": "Active"
}
},
"summary": null,
"territory": null,
"territoryHierarchy": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2/territoryHierarchy"
}
]
},
"winLossDescription": null,
"winLossReason": null,
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/opportunities/2"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/opportunities",
"mediaType": "application/schema+json"
}
]
}