Jump to

• Request
• Response
• Examples

Get an opportunity stage snapshot

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/opportunityStageSnapshots/{OptyStgSnapshotId}

Request

Path Parameters

• OptyNumber(required): string
  The unique alternate identifier for the opportunity.
• OptyStgSnapshotId(required): integer(int64)
  The unique identifier of the opportunity stage snapshot.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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-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 : 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."
        }
    }
}

Back to Top

Examples

The following example shows how to get an opportunity stage snapshot by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_98478/child/opportunityStageSnapshots/300100152433983

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2018-09-10T14:50:43.822+00:00",
            "LastUpdateDate": "2018-09-10T14:50:44.982+00:00",
            "LastUpdateLogin": "758491E29CBE5143E05309B3F20A8502",
            "LastUpdatedBy": "SALES_ADMIN",
            "OptyId": 300100152433944,
            "OptyStgSnapshotId": 300100152433983,
            "StgEnterDate": "2018-09-10T14:48:07+00:00",
            "StgExitDate": null,
            "StgId": 100000012430007,
            "Name": "01 - Qualification",
            "PhaseCd": "QUALIFICATION-DISCOVERY",
            "QuotaFactor": 3,
            "StageStatusCd": "OPEN",
            "StgOrder": 1,
            "links": [
					...
					]
			}

Back to Top