Retrieve an instance of opportunityStatuses

get

/services/rest/connect/latest/opportunityStatuses/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
The default and custom opportunity statuses and their corresponding types.
Root Schema : opportunityStatuses
Type: object
The default and custom opportunity statuses and their corresponding types.
Show Source
Nested Schema : opportunityStatuses-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-opportunityStatuses-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 : namedIDs-opportunityStatuses-names-language
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

Examples

Use GET with the following syntax to retrieve data for an opportunity status object:

https://your_site_interface/services/rest/connect/version/opportunityStatuses/opportunity_status_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/opportunityStatuses/9

Response body example

{
  "id": 9,
  "lookupName": "Active",
  "displayOrder": 3,
  "name": "Active",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/latest/opportunityStatuses/9/names"
      },
      {
        "rel": "full",
        "href": "https://mysite.example.com/services/rest/connect/latest/opportunityStatuses/9/names/{name_id}",
        "templated": true
      }
    ]
  },
  "statusType": {
    "id": 6,
    "lookupName": "Active"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/latest/opportunityStatuses/9"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/latest/opportunityStatuses/9"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/opportunityStatuses",
      "mediaType": "application/schema+json"
    }
  ]
}