Create matrix dimensions
post
/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/ratePlans/{RatePlanId}/child/ratePlanCharges/{RatePlanChargeId}/child/basePriceMatrixes/{MatrixId}/child/dimensions
Request
Path Parameters
-
MatrixId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
PriceListId(required): integer(int64)
Value that uniquely identifies the price list.
-
PriceListItemId(required): integer(int64)
Value that uniquely identifies the price list item.
-
RatePlanChargeId(required): integer(int64)
Value that uniquely identifies the charge of the rate plan.
-
RatePlanId(required): integer(int64)
Value that uniquely identifies the rate plan.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : priceLists-items-ratePlans-ratePlanCharges-basePriceMatrixes-dimensions-item-response
Type:
Show Source
object
-
CompareToAttribute: string
Title:
Compare to Attribute
Read Only:true
Maximum Length:80
Represents the pricing entity attribute to which the dimension is mapped against. -
ComparisonOperatorCode: string
Title:
Comparison
Read Only:true
Maximum Length:30
Default Value:E
Represents the comparison operator. Valid values include =, <,>, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_OPERATORS.,> -
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. -
DataType: string
Title:
Data Type
Read Only:true
Maximum Length:30
Default Value:STRING
Type of the dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DefaultIsFixedValue: string
Title:
Default Is Fixed Value
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the default value for the dimension is fixed. If N, then the default value for the dimension is not fixed. The default value is N. -
DefaultValueDate: string
(date)
Title:
Default Value
Read Only:true
Default value for a dimension with a date data type. -
DefaultValueNumber: number
Title:
Default Value
Read Only:true
Default value for a dimension with a number data type. -
DefaultValueString: string
Title:
Default Value
Read Only:true
Maximum Length:100
Default value for a dimension with a string data type. -
DefaultValueTimestamp: string
(date-time)
Title:
Default Value
Read Only:true
Default value for a dimension with a time stamp data type. -
DimensionId: integer
Value that uniquely identifies the dimension.
-
DimensionName: string
Name of the matrix dimension.
-
DimensionType: string
Title:
ColumnType
Read Only:true
Maximum Length:50
Type of the dimension. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
Sequence in which the dimensions get displayed. -
DomainType: string
Title:
Domain Type
Read Only:true
Maximum Length:30
Default Value:NONE
Type of the domain. Valid values include lookup, view object query, custom, and so on. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
IsNullable: string
Title:
Allow Null
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null. If N, then the dimension cannot be null. The default value is Y. -
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. -
MatrixDimensionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the dimension for a pricing matrix. -
MatrixId: integer
(int64)
Value that uniquely identifies the pricing matrix header.
-
NullasWildCard: string
Title:
Null Is Wildcard
Read Only:true
Maximum Length:1
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension can be null for search. If N, then the dimension cannot be null for search. The default value is Y. -
RequiredDimensionForClass: string
Title:
Required
Read Only:true
Maximum Length:240
Default Value:N
Contains one of the following values: Y or N. If Y, then the dimension is required. If N, then the dimension is not required. The default value is N. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is Displayed
Read Only:true
Maximum Length:1
Default Value:N
Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N. -
SourceCodeName: string
Title:
Source Code Name
Read Only:true
Maximum Length:100
Name of the source code for the matrix dimension.
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.