Create rules
post
/fscmRestApi/resources/11.13.18.05/pricingSegments
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Dimension1: string
Name of the first dimension in the pricing segment matrix.
-
Dimension10: string
Name of the tenth dimension in the pricing segment matrix.
-
Dimension10KeyValue: string
Value that uniquely identifies the tenth dimension value in the pricing segment matrix.
-
Dimension10Value: string
Value of the tenth dimension in the pricing segment matrix.
-
Dimension11: string
Name of the eleventh dimension in the matrix.
-
Dimension11KeyValue: string
Value that uniquely identifies the eleventh dimension value in the matrix.
-
Dimension11Value: string
Value of the eleventh dimension in the matrix.
-
Dimension12: string
Name of the twelfth dimension in the matrix.
-
Dimension12KeyValue: string
Value that uniquely identifies the twelfth dimension value in the matrix.
-
Dimension12Value: string
Value of the twelfth dimension in the matrix.
-
Dimension13: string
Name of the thirteenth dimension in the matrix.
-
Dimension13KeyValue: string
Value that uniquely identifies the thirteenth dimension value in the matrix.
-
Dimension13Value: string
Value of the thirteenth dimension in the matrix.
-
Dimension14: string
Name of the fourteenth dimension in the matrix.
-
Dimension14KeyValue: string
Value that uniquely identifies the fourteenth dimension value in the matrix.
-
Dimension14Value: string
Value of the fourteenth dimension in the matrix.
-
Dimension15: string
Name of the fifteenth dimension in the matrix.
-
Dimension15KeyValue: string
Value that uniquely identifies the fifteenth dimension value in the matrix.
-
Dimension15Value: string
Value of the fifteenth dimension in the matrix.
-
Dimension16: string
Name of the sixteenth dimension in the matrix.
-
Dimension16KeyValue: string
Value that uniquely identifies the sixteenth dimension value in the matrix.
-
Dimension16Value: string
Value of the sixteenth dimension in the matrix.
-
Dimension17: string
Name of the seventeenth dimension in the matrix.
-
Dimension17KeyValue: string
Value that uniquely identifies the seventeenth dimension value in the matrix.
-
Dimension17Value: string
Value of the seventeenth dimension in the matrix.
-
Dimension18: string
Name of the eighteenth dimension in the matrix.
-
Dimension18KeyValue: string
Value that uniquely identifies the eighteenth dimension value in the matrix.
-
Dimension18Value: string
Value of the eighteenth dimension in the matrix.
-
Dimension19: string
Name of the nineteenth dimension in the matrix.
-
Dimension19KeyValue: string
Value that uniquely identifies the nineteenth dimension value in the matrix.
-
Dimension19Value: string
Value of the nineteenth dimension in the matrix.
-
Dimension1KeyValue: string
Value that uniquely identifies the first dimension value in the pricing segment matrix.
-
Dimension1Value: string
Value of the first dimension in the pricing segment matrix.
-
Dimension2: string
Name of the second dimension in the pricing segment matrix.
-
Dimension20: string
Name of the twentieth dimension in the matrix.
-
Dimension20KeyValue: string
Value that uniquely identifies the twentieth dimension value in the matrix.
-
Dimension20Value: string
Value of the twentieth dimension in the matrix.
-
Dimension21: string
Name of the twenty-first dimension in the matrix.
-
Dimension21KeyValue: string
Value that uniquely identifies the twenty-first dimension value in the matrix.
-
Dimension21Value: string
Value of the twenty-first dimension in the matrix.
-
Dimension22: string
Name of the twenty-second dimension in the matrix.
-
Dimension22KeyValue: string
Value that uniquely identifies the twenty-second dimension value in the matrix.
-
Dimension22Value: string
Value of the twenty-second dimension in the matrix.
-
Dimension23: string
Name of the twenty-third dimension in the matrix.
-
Dimension23KeyValue: string
Value that uniquely identifies the twenty-third dimension value in the matrix.
-
Dimension23Value: string
Value of the twenty-third dimension in the matrix.
-
Dimension24: string
Name of the twenty-fourth dimension in the matrix.
-
Dimension24KeyValue: string
Value that uniquely identifies the twenty-fourth dimension value in the matrix.
-
Dimension24Value: string
Value of the twenty-fourth dimension in the matrix.
-
Dimension25: string
Name of the twenty-fifth dimension in the matrix.
-
Dimension25KeyValue: string
Value that uniquely identifies the twenty-fifth dimension value in the matrix.
-
Dimension25Value: string
Value of the twenty-fifth dimension in the matrix.
-
Dimension2KeyValue: string
Value that uniquely identifies the second dimension value in the pricing segment matrix.
-
Dimension2Value: string
Value of the second dimension in the pricing segment matrix.
-
Dimension3: string
Name of the third dimension in the pricing segment matrix.
-
Dimension3KeyValue: string
Value that uniquely identifies the third dimension value in the pricing segment matrix.
-
Dimension3Value: string
Value of the third dimension in the pricing segment matrix.
-
Dimension4: string
Name of the fourth dimension in the pricing segment matrix.
-
Dimension4KeyValue: string
Value that uniquely identifies the fourth dimension value in the pricing segment matrix.
-
Dimension4Value: string
Value of the fourth dimension in the pricing segment matrix.
-
Dimension5: string
Name of the fifth dimension in the pricing segment matrix.
-
Dimension5KeyValue: string
Value that uniquely identifies the fifth dimension value in the pricing segment matrix.
-
Dimension5Value: string
Value of the fifth dimension in the pricing segment matrix.
-
Dimension6: string
Name of the sixth dimension in the pricing segment matrix.
-
Dimension6KeyValue: string
Value that uniquely identifies the sixth dimension value in the pricing segment matrix.
-
Dimension6Value: string
Value of the sixth dimension in the pricing segment matrix.
-
Dimension7: string
Name of the seventh dimension in the pricing segment matrix.
-
Dimension7KeyValue: string
Value that uniquely identifies the seventh dimension value in the pricing segment matrix.
-
Dimension7Value: string
Value of the seventh dimension in the pricing segment matrix.
-
Dimension8: string
Name of the eighth dimension in the pricing segment matrix.
-
Dimension8KeyValue: string
Value that uniquely identifies the eighth dimension value in the pricing segment matrix.
-
Dimension8Value: string
Value of the eighth dimension in the pricing segment matrix.
-
Dimension9: string
Name of the ninth dimension in the pricing segment matrix.
-
Dimension9KeyValue: string
Value that uniquely identifies the ninth dimension value in the pricing segment matrix.
-
Dimension9Value: string
Value of the ninth dimension in the pricing segment matrix.
-
RuleEndDate: string
(date-time)
Title:
End Date
Date when the pricing segment rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the pricing segment rule becomes active.
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.
Root Schema : pricingSegments-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the record was created. -
Dimension1: string
Name of the first dimension in the pricing segment matrix.
-
Dimension10: string
Name of the tenth dimension in the pricing segment matrix.
-
Dimension10KeyValue: string
Value that uniquely identifies the tenth dimension value in the pricing segment matrix.
-
Dimension10Value: string
Value of the tenth dimension in the pricing segment matrix.
-
Dimension11: string
Name of the eleventh dimension in the matrix.
-
Dimension11KeyValue: string
Value that uniquely identifies the eleventh dimension value in the matrix.
-
Dimension11Value: string
Value of the eleventh dimension in the matrix.
-
Dimension12: string
Name of the twelfth dimension in the matrix.
-
Dimension12KeyValue: string
Value that uniquely identifies the twelfth dimension value in the matrix.
-
Dimension12Value: string
Value of the twelfth dimension in the matrix.
-
Dimension13: string
Name of the thirteenth dimension in the matrix.
-
Dimension13KeyValue: string
Value that uniquely identifies the thirteenth dimension value in the matrix.
-
Dimension13Value: string
Value of the thirteenth dimension in the matrix.
-
Dimension14: string
Name of the fourteenth dimension in the matrix.
-
Dimension14KeyValue: string
Value that uniquely identifies the fourteenth dimension value in the matrix.
-
Dimension14Value: string
Value of the fourteenth dimension in the matrix.
-
Dimension15: string
Name of the fifteenth dimension in the matrix.
-
Dimension15KeyValue: string
Value that uniquely identifies the fifteenth dimension value in the matrix.
-
Dimension15Value: string
Value of the fifteenth dimension in the matrix.
-
Dimension16: string
Name of the sixteenth dimension in the matrix.
-
Dimension16KeyValue: string
Value that uniquely identifies the sixteenth dimension value in the matrix.
-
Dimension16Value: string
Value of the sixteenth dimension in the matrix.
-
Dimension17: string
Name of the seventeenth dimension in the matrix.
-
Dimension17KeyValue: string
Value that uniquely identifies the seventeenth dimension value in the matrix.
-
Dimension17Value: string
Value of the seventeenth dimension in the matrix.
-
Dimension18: string
Name of the eighteenth dimension in the matrix.
-
Dimension18KeyValue: string
Value that uniquely identifies the eighteenth dimension value in the matrix.
-
Dimension18Value: string
Value of the eighteenth dimension in the matrix.
-
Dimension19: string
Name of the nineteenth dimension in the matrix.
-
Dimension19KeyValue: string
Value that uniquely identifies the nineteenth dimension value in the matrix.
-
Dimension19Value: string
Value of the nineteenth dimension in the matrix.
-
Dimension1KeyValue: string
Value that uniquely identifies the first dimension value in the pricing segment matrix.
-
Dimension1Value: string
Value of the first dimension in the pricing segment matrix.
-
Dimension2: string
Name of the second dimension in the pricing segment matrix.
-
Dimension20: string
Name of the twentieth dimension in the matrix.
-
Dimension20KeyValue: string
Value that uniquely identifies the twentieth dimension value in the matrix.
-
Dimension20Value: string
Value of the twentieth dimension in the matrix.
-
Dimension21: string
Name of the twenty-first dimension in the matrix.
-
Dimension21KeyValue: string
Value that uniquely identifies the twenty-first dimension value in the matrix.
-
Dimension21Value: string
Value of the twenty-first dimension in the matrix.
-
Dimension22: string
Name of the twenty-second dimension in the matrix.
-
Dimension22KeyValue: string
Value that uniquely identifies the twenty-second dimension value in the matrix.
-
Dimension22Value: string
Value of the twenty-second dimension in the matrix.
-
Dimension23: string
Name of the twenty-third dimension in the matrix.
-
Dimension23KeyValue: string
Value that uniquely identifies the twenty-third dimension value in the matrix.
-
Dimension23Value: string
Value of the twenty-third dimension in the matrix.
-
Dimension24: string
Name of the twenty-fourth dimension in the matrix.
-
Dimension24KeyValue: string
Value that uniquely identifies the twenty-fourth dimension value in the matrix.
-
Dimension24Value: string
Value of the twenty-fourth dimension in the matrix.
-
Dimension25: string
Name of the twenty-fifth dimension in the matrix.
-
Dimension25KeyValue: string
Value that uniquely identifies the twenty-fifth dimension value in the matrix.
-
Dimension25Value: string
Value of the twenty-fifth dimension in the matrix.
-
Dimension2KeyValue: string
Value that uniquely identifies the second dimension value in the pricing segment matrix.
-
Dimension2Value: string
Value of the second dimension in the pricing segment matrix.
-
Dimension3: string
Name of the third dimension in the pricing segment matrix.
-
Dimension3KeyValue: string
Value that uniquely identifies the third dimension value in the pricing segment matrix.
-
Dimension3Value: string
Value of the third dimension in the pricing segment matrix.
-
Dimension4: string
Name of the fourth dimension in the pricing segment matrix.
-
Dimension4KeyValue: string
Value that uniquely identifies the fourth dimension value in the pricing segment matrix.
-
Dimension4Value: string
Value of the fourth dimension in the pricing segment matrix.
-
Dimension5: string
Name of the fifth dimension in the pricing segment matrix.
-
Dimension5KeyValue: string
Value that uniquely identifies the fifth dimension value in the pricing segment matrix.
-
Dimension5Value: string
Value of the fifth dimension in the pricing segment matrix.
-
Dimension6: string
Name of the sixth dimension in the pricing segment matrix.
-
Dimension6KeyValue: string
Value that uniquely identifies the sixth dimension value in the pricing segment matrix.
-
Dimension6Value: string
Value of the sixth dimension in the pricing segment matrix.
-
Dimension7: string
Name of the seventh dimension in the pricing segment matrix.
-
Dimension7KeyValue: string
Value that uniquely identifies the seventh dimension value in the pricing segment matrix.
-
Dimension7Value: string
Value of the seventh dimension in the pricing segment matrix.
-
Dimension8: string
Name of the eighth dimension in the pricing segment matrix.
-
Dimension8KeyValue: string
Value that uniquely identifies the eighth dimension value in the pricing segment matrix.
-
Dimension8Value: string
Value of the eighth dimension in the pricing segment matrix.
-
Dimension9: string
Name of the ninth dimension in the pricing segment matrix.
-
Dimension9KeyValue: string
Value that uniquely identifies the ninth dimension value in the pricing segment matrix.
-
Dimension9Value: string
Value of the ninth dimension in the pricing segment matrix.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the record was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pricing segment matrix header. -
MatrixRuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the pricing segment matrix rule. -
RuleEndDate: string
(date-time)
Title:
End Date
Date when the pricing segment rule becomes inactive. -
RuleStartDate: string
(date-time)
Title:
Start Date
Date when the pricing segment rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create rules.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/pricingSegments"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "Dimension1" : "Revenue Potential", "Dimension1Value" : "Very high", "Dimension2" : "Cost To Serve", "Dimension2Value" : "Very high", "Dimension3" : "Customer Size", "Dimension3Value" : "Large", "Dimension4" : "Customer Value", "Dimension4Value" : "Very high", "Dimension5" : "Customer Rating", "Dimension5KeyValue" : "ORA_VERY_HIGH", "Dimension6" : "Pricing Segment", "Dimension6Value" : "OM QA Segment", "Dimension7" : "Precedence", "Dimension7Value" : "2", "RuleStartDate" : "2015-06-01T14:09:00+00:00" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "MatrixRuleId" : 300100174277022, "MatrixId" : 300100071623739, "Dimension1" : "Revenue Potential", "Dimension1Value" : "Very high", "Dimension1KeyValue" : "ORA_VERY_HIGH", "Dimension2" : "Customer Size", "Dimension2Value" : "Large", "Dimension2KeyValue" : "ORA_LARGE", "Dimension3" : "Cost To Serve", "Dimension3Value" : "Very high", "Dimension3KeyValue" : "ORA_VERY_HIGH", "Dimension4" : "Customer Value", "Dimension4Value" : "Very high", "Dimension4KeyValue" : "ORA_VERY_HIGH", "Dimension5" : "Customer Rating", "Dimension5Value" : "Very high", "Dimension5KeyValue" : "ORA_VERY_HIGH", "Dimension6" : "Pricing Segment", "Dimension6Value" : "OM QA Segment", "Dimension6KeyValue" : "OM_QA_SEGMENT", "Dimension7" : "Precedence", "Dimension7Value" : "2", "Dimension7KeyValue" : "2", "Dimension8" : null, "Dimension8Value" : null, "Dimension8KeyValue" : null, "Dimension9" : null, "Dimension9Value" : null, "Dimension9KeyValue" : null, "Dimension10" : null, "Dimension10Value" : null, "Dimension10KeyValue" : null, "RuleStartDate" : "2015-06-01T14:09:00+00:00", "RuleEndDate" : null, "CreationDate" : "2018-11-19T09:02:35+00:00", "CreatedBy" : "PRICING_MGR_OPERATIONS", "LastUpdateDate" : "2018-11-19T09:02:43.333+00:00", "LastUpdatedBy" : "PRICING_MGR_OPERATIONS" }