1. REST API for Oracle B2C Service
  2. Tasks
  3. Opportunities

Get an opportunity

get

/services/rest/connect/v1.4/opportunities/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
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
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-banner
Type: object
The display flags of a banner.
Show Source
Nested Schema : opportunities-closedValue
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-costOfSale
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-fileAttachments
Type: object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
  • 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.
  • The date and time when the file was associated with the object. This attribute is read-only.
  • The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
  • Maximum Length: 1333
    The description for the contents of the file attachment.
  • Maximum Length: 100
    Pattern: ^[^ \/:*?"<>|]*$
    The name of the file when saving it to the disk.
  • The HTML form which is used to upload file attachments.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the file attachment.
  • Maximum Length: 40
    Pattern: ^[^ ]*$
    The short display name of the file attachment.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The size of the file in bytes. This attribute is read-only.
  • The date and time when the file attachment was last updated. This attribute is read-only.
  • 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
Nested Schema : opportunities-managerValue
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
  • 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.
  • 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.
  • The date and time when the note was created. This attribute is read-only.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the note.
  • Maximum Length: 349525
    The text content in the note.
  • 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.
  • 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
    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.
  • 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
    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.
  • 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
Nested Schema : opportunities-returnValue
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-salesRepresentativeValue
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
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
Nested Schema : opportunities-stageWithStrategy
Type: object
The stage an opportunity has reached within a sales strategy.
Show Source
Nested Schema : opportunities-statusWithType
Type: object
The status of an object with its associated status type.
Show Source
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
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
Nested Schema : items
Type: object
Nested Schema : namedIDs-opportunities-banner-importanceFlag
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
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
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
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
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
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
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
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
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
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
Nested Schema : opportunities-quotes-adjustedTotal
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-quotes-fileAttachments
Type: object
The file that is attached or associated with another object.
Show Source
  • 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.
  • The date and time when the file was associated with the object. This attribute is read-only.
  • The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
  • Maximum Length: 100
    Pattern: ^[^ \/:*?"<>|]*$
    The name of the file when saving it to the disk.
  • The HTML form which is used to upload file attachments.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the file attachment.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The size of the file in bytes. This attribute is read-only.
  • The date and time when the file was last updated. This attribute is read-only.
  • 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
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
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
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
Nested Schema : opportunities-quotes-total
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
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
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
Nested Schema : opportunities-quotes-lineItems-adjustedPrice
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-quotes-lineItems-adjustedTotal
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : opportunities-quotes-lineItems-originalPrice
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Nested Schema : items
Type: object
Back to Top

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"
    }
  ]
}
Back to Top