1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Opportunities
  4. Opportunity Stage Snapshots

Get all opportunity stage snapshots

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds an opportunity stage snapshot by the opportunity stage snapshot identifier.
      Finder Variables:
      • OptyStgSnapshotId; integer; The unique identifier of the opportunity stage snapshot.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActiveFlag; boolean; Indicates whether the opportunity stage snapshot is active.
    • ConflictId; integer; This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
    • CreatedBy; string; The user who created the opportunity stage snapshot.
    • CreationDate; string; The date when the opportunity stage snapshot was created.
    • LastUpdateDate; string; The date when the opportunity stage snapshot was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the opportunity stage snapshot.
    • LastUpdatedBy; string; The user who last updated the opportunity stage snapshot.
    • Name; string; The name of the opportunity stage snapshot.
    • OptyId; integer; The unique identifier of the opportunity.
    • OptyStgSnapshotId; integer; The unique identifier of the opportunity stage snapshot.
    • PhaseCd; string; The current phase of the opportunity sales stage.
    • QuotaFactor; number; The quota factor of the opportunity sales stage.
    • StageStatusCd; string; The code indicating the default status for the opportunity's sales stage.
    • StgEnterDate; string; The date when the opportunity entered a sales stage.
    • StgExitDate; string; The date when the opportunity exited a sales stage.
    • StgId; integer; The unique identifier of the opportunity sales stage.
    • StgOrder; number; The order of the opportunity's sales stage in the sales method.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : opportunities-opportunityStageSnapshots-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Indicates whether the opportunity stage snapshot is active.
  • Title: Conflict ID
    Default Value: 0
    This value is used to guarantee the uniqueness of the row when duplicates are created in different databases.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the opportunity stage snapshot.
  • Title: Creation Date
    Read Only: true
    The date when the opportunity stage snapshot was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the opportunity stage snapshot was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the opportunity stage snapshot.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the opportunity stage snapshot.
  • Links
  • Title: Sales Stage
    Read Only: true
    Maximum Length: 50
    The name of the opportunity stage snapshot.
  • Title: Opportunity ID
    The unique identifier of the opportunity.
  • Title: Opportunity Stage Snapshot ID
    The unique identifier of the opportunity stage snapshot.
  • Title: Sales Stage Phase
    Read Only: true
    Maximum Length: 30
    Default Value: "B - Working the Deal"
    The current phase of the opportunity sales stage.
  • Title: Sales Stage Quota Factor
    Read Only: true
    The quota factor of the opportunity sales stage.
  • 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.
  • Title: Sales Stage Enter Date
    The date when the opportunity entered a sales stage.
  • Title: Sales Stage Exit Date
    The date when the opportunity exited a sales stage.
  • Title: Sales Stage ID
    The unique identifier of the opportunity sales stage.
  • Title: Sales Stage Order
    Read Only: true
    The order of the opportunity's sales stage in the sales method.
Back to Top

Examples

The following example shows how to get all opportunity stage snapshots 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

Example of Response Body

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

{
    "items": [
        {
            "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