1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Order Management
  4. Pricing Matrixes
  5. Matrix Dimensions

Get all matrix dimensions

get

/fscmRestApi/resources/11.13.18.05/pricingMatrixes/{MatrixId}/child/dimensions

Request

Path Parameters
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 matrix dimensions according to the primary key.
      Finder Variables:
      • MatrixDimensionId; integer; Value that uniquely identifies the matrix dimension.
  • 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:
    • CompareToAttribute; string; Represents the pricing entity attribute to which the dimension is mapped against.
    • ComparisonOperatorCode; string; 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; User who created the record.
    • CreationDate; string; Date and time when the record was created.
    • DataType; 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; 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; Default value for a dimension with a date data type.
    • DefaultValueNumber; number; Default value for a dimension with a number data type.
    • DefaultValueString; string; Default value for a dimension with a string data type.
    • DefaultValueTimestamp; string; 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; Type of the dimension.
    • DisplaySequence; integer; Sequence in which the dimensions get displayed.
    • DomainType; string; 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; 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 and time when the record was most recently updated.
    • LastUpdatedBy; string; User who most recently updated the record.
    • MatrixDimensionId; integer; Value that uniquely identifies the dimension for a pricing matrix.
    • MatrixId; integer; Value that uniquely identifies the pricing matrix header.
    • NullasWildCard; string; 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; 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; 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; Name of the source code for the matrix dimension.
  • 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 : pricingMatrixes-dimensions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : pricingMatrixes-dimensions-item-response
Type: object
Show Source
  • Title: Compare to Attribute
    Read Only: true
    Maximum Length: 80
    Represents the pricing entity attribute to which the dimension is mapped against.
  • 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.
  • 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
    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.
  • 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.
  • Title: Default Value
    Read Only: true
    Default value for a dimension with a date data type.
  • Title: Default Value
    Read Only: true
    Default value for a dimension with a number data type.
  • Title: Default Value
    Read Only: true
    Maximum Length: 100
    Default value for a dimension with a string data type.
  • Title: Default Value
    Read Only: true
    Default value for a dimension with a time stamp data type.
  • Value that uniquely identifies the dimension.
  • Name of the matrix dimension.
  • Title: ColumnType
    Read Only: true
    Maximum Length: 50
    Type of the dimension.
  • Title: Display Sequence
    Read Only: true
    Sequence in which the dimensions get displayed.
  • 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.
  • 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.
  • Read Only: true
    Date and time when the record was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • Read Only: true
    Value that uniquely identifies the dimension for a pricing matrix.
  • Value that uniquely identifies the pricing matrix header.
  • 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.
  • 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.
  • 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.
  • Title: Source Code Name
    Read Only: true
    Maximum Length: 100
    Name of the source code for the matrix dimension.
Back to Top

Examples

This example describes how to get all matrix dimensions.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/pricingMatrixes/MatrixId/child/dimensions"

Example Response Body

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

{
 "items": [
 {
    "MatrixDimensionId": 300100149915482,
    "MatrixId": 300100149915150,
    "DimensionName": "Party",
    "DimensionId": 300100130121957,
    "DimensionType": "Condition",
    "DataType": "TIMESTAMP",
    "DomainType": "CUSTOM",
    "DisplaySequence": 107,
    "ComparisonOperatorCode": "E",
    "CompareToAttribute": "IncludeFlag",
    "RequiredDimensionForClass": "N",
    "IsNullable": "Y",
    "NullasWildCard": "Y",
    "DefaultIsFixedValue": "N",
    "CreationDate": "2018-05-21T05:59:34+00:00",
    "CreatedBy": "PRICING_MGR_OPERATIONS",
    "LastUpdateDate": "2018-05-21T05:59:34.013+00:00",
    "LastUpdatedBy": "PRICING_MGR_OPERATIONS"
  },
  {
      ...
  } 
 ]
}
Back to Top