Get all pricing matrix classes

get

/fscmRestApi/resources/11.13.18.05/pricingMatrixClasses

Request

Query Parameters
  • 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 pricing matrix classes according to the primary key.
      Finder Variables
      • MatrixClassId; integer; Value that uniquely identifies the pricing matrix class.
    • findByMatrixClassName Finds pricing matrix classes according to the matrix class name.
      Finder Variables
      • MatrixClassName; string; Value that identifies the matrix class name of a pricing matrix class.
  • 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:
    • CanAddNewDimensions; string; 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; Context consumer service for the pricing matrix class.
    • CreatedBy; string; User who created the record.
    • CreationDate; string; Date and time when the record was created.
    • DateEffectivityEnabled; string; 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.
    • IsPublic; string; 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; Most recent date and time when the application updated the record.
    • LastUpdatedBy; string; User who most recently updated the record.
    • MatrixClassId; integer; Value that uniquely identifies the pricing matrix class.
    • MatrixClassName; string; Name of the pricing matrix class.
  • 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 : pricingMatrixClasses
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : pricingMatrixClasses-item-response
Type: object
Show Source
  • 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.
  • Title: Service
    Maximum Length: 500
    Context consumer service for the pricing matrix class.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the record was created.
  • 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
    Title: Dimensions
    The Dimensions resource contains information to manage pricing matrix dimensions.
  • 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.
  • Read Only: true
    Most recent date and time when the application updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Value that uniquely identifies the pricing matrix class.
  • 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 : pricingMatrixClasses-dimensions-item-response
Type: object
Show Source
  • Title: Compare to Attribute
    Maximum Length: 80
    Attribute that's used along with the Compare To Entity for comparison during matrix dimension evaluation.
  • Title: Compare to Entity
    Maximum Length: 80
    Entity that's used along with the Compare To Attribute for comparison for the matrix dimension evaluation.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the record was created.
  • 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.
  • 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.
  • Title: Default Value
    Default date for the matrix dimension.
  • Title: Default Value
    Default number for the matrix dimension.
  • Title: Default Value
    Maximum Length: 100
    Default string for the matrix dimension.
  • Title: Default Value
    Default timestamp value for the matrix dimension.
  • Title: ColumnType
    Maximum Length: 50
    Dimension type for a matrix dimension.
  • Title: Display Sequence
    Display sequence for the matrix dimension.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Most recent date and time when the application updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Value that uniquely identifies the matrix class for the matrix dimension.
  • Value that uniquely identifies the matrix dimension.
  • Title: Name
    Maximum Length: 100
    Name of the matrix dimension associated with the matrix class.
  • 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.
  • 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.
  • Title: Source Code Name
    Maximum Length: 100
    Name of the source code for the matrix dimension.
Back to Top