1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Deal Registrations
  4. Products

Get all products

get

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Deal Registrations resource and used to uniquely identify an instance of Deal Registrations. The client should not generate the hash key value. Instead, the client should query on the Deal Registrations collection resource in order to navigate to a specific instance of Deal Registrations to get the hash key.
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 the product or item with the specified parameters.
      Finder Variables:
      • InvOrgId; integer; The inventory organization to which the product or item belongs.
      • InventoryItemId; integer; The unique identifier of the product or item associated with the deal registration.
  • 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:
    • CSSEnabled; string; Indicates if the product is enabled for customer self-service. The default value is No.
    • Description; string; The description of the product associated with the deal registration.
    • LongDescription; string; The description for the product.
    • ProductNum; string; The unique alternate identifier of the product.
    • ProductType; string; The type of the product.
    • ServiceRequestEnabledCode; string; Indicates if service requests are enabled for the associated product.
    • Text; string; The text or keywords associated with the product.
  • 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 : deals-products
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : deals-products-item-response
Type: object
Show Source
Links
setSelectedProductGroupId
Parameters:
  • dealsUniqID: $request.path.dealsUniqID
This method lets you set the user selected product group.
setUsageCode
Parameters:
  • dealsUniqID: $request.path.dealsUniqID
This method lets you set a product usage code.
setUsageMode
Parameters:
  • dealsUniqID: $request.path.dealsUniqID
This method lets you set the product usage mode.
setUserSelectionForTM
Parameters:
  • dealsUniqID: $request.path.dealsUniqID
This method lets you set the territory filter for user choice.
Back to Top

Examples

The following example shows how to get all products 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/deals/300100071569813/child/products

Example of Response Body

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

{
 -items: [25]
  -0:  
    {
     ParentId: 300100071569813
     UsageCode: "BASE"
     Description: " OPN - World Applications - Certified Partner"
     StartDate: "1951-01-01T00:00:00-08:00"
     EndDate: "4712-12-31T00:00:00-08:00"
     InventoryItemId: 999997500683977
     InvOrgId: 204
     ProductNum: "TG9"
     LongDescription: "License/Applications/ERP Applications/PeopleSoft  
     ERP Applications/JD Edwards World ERP/OPN - World License/ OPN -    
     World Applications - Certified Partner"
     CustomerOrderEnabledFlag: "Y"
     ProdGroupId: 999997826070843
     ...
}
Back to Top