Jump to

• Request
• Response
• Examples

Get an opportunity status

get

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

Request

Path Parameters

• id(required): integer
  The unique identifier of the opportunity status.

Back to Top

Response

Default Response

Body ()

Root Schema : opportunityStatuses

Type: object

The information about the default and custom opportunity statuses and their corresponding types. The default opportunity statuses are Lead, Reject, Active, Closed, Lost, Inactive, and Dead.

Show Source

• createdTime: string
  The date and time when the opportunity status was created. This attribute is read-only.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The position of the opportunity status in the folder list.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the opportunity status.
• lookupName: string
  Maximum Length: 255

  The name used to look up the opportunity status.
• name: string
  Maximum Length: 80

  The name of the opportunity status in the language of the current interface.
• names: object opportunityStatuses-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• statusType: object namedIDs-opportunityStatuses-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.
• updatedTime: string
  The date and time when the opportunity status was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The information about the default and custom opportunity statuses and their corresponding types. The default opportunity statuses are Lead, Reject, Active, Closed, Lost, Inactive, and Dead.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the opportunity status was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the opportunity status in the language of the current interface.",
            "maxLength":"80"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the opportunity status.",
            "maxLength":"255"
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/opportunityStatuses-names"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the opportunity status was created. This attribute is read-only."
        },
        "statusType":{
            "type":"object",
            "description":"The current status and associated status type.",
            "$ref":"#/definitions/namedIDs-opportunityStatuses-statusType"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the opportunity status.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The position of the opportunity status in the folder list.",
            "maximum":"2147483647"
        }
    }
}

Nested Schema : opportunityStatuses-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: object namedIDs-opportunityStatuses-names-language
  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.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-opportunityStatuses-names-language"
        }
    }
}

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

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

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"
    }
  ]
}

Back to Top