Jump to

• Request
• Response

Get all matrix dimensions

get

/fscmRestApi/resources/11.13.18.05/priceLists/{PriceListId}/child/items/{PriceListItemId}/child/charges/{PriceListChargeId}/child/pricingMatrixes/{MatrixId}/child/dimensions

Request

Path Parameters

• MatrixId(required): integer(int64)
  Value that uniquely identifies the pricing matrix header.
• PriceListChargeId(required): integer(int64)
  Value that uniquely identifies the charge of the price list item.
• PriceListId(required): integer(int64)
  Value that uniquely identifies the price list.
• PriceListItemId(required): integer(int64)
  Value that uniquely identifies the price list item.

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
• finder: string
  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.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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.
• totalResults: boolean
  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

• 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 Top

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.

Body ()

Root Schema : priceLists-items-charges-pricingMatrixes-dimensions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Price List Items
  Title: Price List Items

  The Price List Items resource manages the items in a price list. This resource does not manage the components and covered items.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Price List Items",
            "type":"array",
            "description":"The Price List Items resource manages the items in a price list. This resource does not manage the components and covered items.",
            "items":{
                "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-dimensions-item-response"
            }
        }
    }
}

Nested Schema : Price List Items

Type: array

Title: Price List Items

The Price List Items resource manages the items in a price list. This resource does not manage the components and covered items.

Show Source

• Array of: object priceLists-items-charges-pricingMatrixes-dimensions-item-response

{
    "title":"Price List Items",
    "type":"array",
    "description":"The Price List Items resource manages the items in a price list. This resource does not manage the components and covered items.",
    "items":{
        "$ref":"#/components/schemas/priceLists-items-charges-pricingMatrixes-dimensions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : priceLists-items-charges-pricingMatrixes-dimensions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DimensionType":{
            "title":"ColumnType",
            "maxLength":50,
            "type":"string",
            "description":"Type of the dimension.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredDimensionForClass":{
            "title":"Required",
            "maxLength":240,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Sequence in which the dimensions get displayed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension for a pricing matrix.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DomainType":{
            "title":"Domain Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"NONE",
            "x-queryable":true
        },
        "DefaultValueDate":{
            "title":"Default Value",
            "type":"string",
            "description":"Default value for a dimension with a date data type.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueNumber":{
            "title":"Default Value",
            "type":"number",
            "description":"Default value for a dimension with a number data type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompareToAttribute":{
            "title":"Compare to Attribute",
            "maxLength":80,
            "type":"string",
            "description":"Represents the pricing entity attribute to which the dimension is mapped against.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"STRING",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultIsFixedValue":{
            "title":"Default Is Fixed Value",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsNullable":{
            "title":"Allow Null",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "NullasWildCard":{
            "title":"Null Is Wildcard",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "DefaultValueString":{
            "title":"Default Value",
            "maxLength":100,
            "type":"string",
            "description":"Default value for a dimension with a string data type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShowDefaultValueDimensionInRules":{
            "title":"Fixed Column Is Displayed",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the dimension with a fixed default value needs to be displayed in the matrix rules user interface. The default value is N.",
            "nullable":false,
            "readOnly":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "title":"Comparison",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":"E",
            "x-queryable":true
        },
        "DimensionName":{
            "type":"string",
            "description":"Name of the matrix dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceCodeName":{
            "title":"Source Code Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the source code for the matrix dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueTimestamp":{
            "title":"Default Value",
            "type":"string",
            "description":"Default value for a dimension with a time stamp data type.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the pricing matrix header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top