Get one pricing matrix class
get
/fscmRestApi/resources/11.13.18.05/pricingMatrixClasses/{pricingMatrixClassesUniqID}
Request
Path Parameters
-
pricingMatrixClassesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Pricing Matrix Classes resource and used to uniquely identify an instance of Pricing Matrix Classes. The client should not generate the hash key value. Instead, the client should query on the Pricing Matrix Classes collection resource in order to navigate to a specific instance of Pricing Matrix Classes to get the hash key.
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 TopResponse
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 : pricingMatrixClasses-item-response
Type:
Show Source
object
-
CanAddNewDimensions: string
Title:
Can Add New Columns
Maximum Length:1
Default Value:N
Contains one of the following values. Y: pricing matrix class allows for new matrix dimensions. N: pricing matrix class doesn't allow for new matrix dimensions. This attribute doesn't have a default value. -
ContextConsumer: string
Title:
Service
Maximum Length:500
Context consumer service for the pricing matrix class. -
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. -
DateEffectivityEnabled: string
Title:
Date Effectivity Enabled
Maximum Length:1
Default Value:N
Contains one of the following values. Y: pricing matrix class is date effectivity enabled. N: pricing matrix class isn't date effectivity enabled. This attribute doesn't have a default value. -
dimensions: array
Dimensions
Title:
Dimensions
The Dimensions resource contains information to manage pricing matrix dimensions. -
IsPublic: string
Title:
Public
Maximum Length:1
Default Value:N
Contains one of the following values. Y: pricing matrix class is public and is shared. N: pricing matrix class isn't public and can't be shared. This attribute doesn't have a default value. -
LastUpdateDate: string
(date-time)
Read Only:
true
Most recent date and time when the application updated the record. -
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. -
MatrixClassId: integer
(int64)
Value that uniquely identifies the pricing matrix class.
-
MatrixClassName: string
Title:
Name
Maximum Length:100
Name of the pricing matrix class.
Nested Schema : Dimensions
Type:
array
Title:
Dimensions
The Dimensions resource contains information to manage pricing matrix dimensions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : pricingMatrixClasses-dimensions-item-response
Type:
Show Source
object
-
CompareToAttr: string
Title:
Compare to Attribute
Maximum Length:80
Attribute that's used along with the Compare To Entity for comparison during matrix dimension evaluation. -
CompareToEntity: string
Title:
Compare to Entity
Maximum Length:80
Entity that's used along with the Compare To Attribute for comparison for the matrix dimension evaluation. -
ComparisonOperator: string
Title:
Comparison
Maximum Length:30
Default Value:E
Comparison operator for the matrix dimension. 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
Maximum Length:30
Default Value:STRING
Type of data for the matrix dimension. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DefaultIsFixedValue: string
Title:
Default Is Fixed Value
Maximum Length:1
Default Value:N
Contains one of the following values. Y: default value for the matrix dimension is fixed and can't be changed. N: default value for the matrix dimension isn't fixed and can be changed. This attribute doesn't have a default value. -
DefaultValueDate: string
(date)
Title:
Default Value
Default date for the matrix dimension. -
DefaultValueNumber: number
Title:
Default Value
Default number for the matrix dimension. -
DefaultValueString: string
Title:
Default Value
Maximum Length:100
Default string for the matrix dimension. -
DefaultValueTimestamp: string
(date-time)
Title:
Default Value
Default timestamp value for the matrix dimension. -
DimensionType: string
Title:
ColumnType
Maximum Length:50
Dimension type for a matrix dimension. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Display sequence for the matrix dimension. -
DomainType: string
Title:
Domain Type
Maximum Length:30
Default Value:NONE
Type of domain for the matrix dimension. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
IsNullable: string
Title:
Allow Null
Maximum Length:1
Default Value:N
Contains one of the following values. Y: matrix dimension can be null. N: matrix dimension can??t be null. This attribute doesn't have a default value. -
IsRequired: string
Title:
Required
Maximum Length:240
Default Value:N
Contains one of the following values. Y: matrix dimension is required. N: matrix dimension isn't required. This attribute doesn't have a default value. -
LastUpdateDate: string
(date-time)
Read Only:
true
Most recent date and time when the application updated the record. -
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. -
MatrixClassId: integer
(int64)
Value that uniquely identifies the matrix class for the matrix dimension.
-
MatrixDimensionId: integer
(int64)
Value that uniquely identifies the matrix dimension.
-
MatrixDimensionName: string
Title:
Name
Maximum Length:100
Name of the matrix dimension associated with the matrix class. -
NullInRuleIsWildCard: string
Title:
Null Is Wildcard
Maximum Length:1
Default Value:N
Contains one of the following values. Y: empty value is evaluated as any match. N: empty value isn't evaluated as any match. This attribute doesn't have a default value. -
ShowDefaultValueDimensionInRules: string
Title:
Fixed Column Is Displayed
Maximum Length:1
Default Value:N
Value that indicates whether the dimension with a fixed default value must be displayed in the matrix rules user interface. The default value is N. -
SourceCodeName: string
Title:
Source Code Name
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.
Links
- dimensions
-
Parameters:
- pricingMatrixClassesUniqID:
$request.path.pricingMatrixClassesUniqID
The Dimensions resource contains information to manage pricing matrix dimensions. - pricingMatrixClassesUniqID: