Jump to

• Request
• Response

Get all matrix dimensions associated with the matrix class

get

/fscmRestApi/resources/11.13.18.05/pricingMatrixClasses/{pricingMatrixClassesUniqID}/child/dimensions

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
• 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 identifies the matrix dimension of a pricing matrix class.
• 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:
  

  • CompareToAttr; string; Attribute that's used along with the Compare To Entity for comparison during matrix dimension evaluation.
  • CompareToEntity; string; Entity that's used along with the Compare To Attribute for comparison for the matrix dimension evaluation.
  • ComparisonOperator; string; Comparison operator for the matrix dimension. 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 data for the matrix dimension. 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: 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; Default date for the matrix dimension.
  • DefaultValueNumber; number; Default number for the matrix dimension.
  • DefaultValueString; string; Default string for the matrix dimension.
  • DefaultValueTimestamp; string; Default timestamp value for the matrix dimension.
  • DimensionType; string; Dimension type for a matrix dimension.
  • DisplaySequence; integer; Display sequence for the matrix dimension.
  • DomainType; string; 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; 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; 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; 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 matrix class for the matrix dimension.
  • MatrixDimensionId; integer; Value that uniquely identifies the matrix dimension.
  • MatrixDimensionName; string; Name of the matrix dimension associated with the matrix class.
  • NullInRuleIsWildCard; string; 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; 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; 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:
  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.

Body ()

Root Schema : pricingMatrixClasses-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 Items
  Title: Items

  The items in the collection.
• 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":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/pricingMatrixClasses-dimensions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object pricingMatrixClasses-dimensions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/pricingMatrixClasses-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 : pricingMatrixClasses-dimensions-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionType":{
            "title":"ColumnType",
            "maxLength":"50",
            "type":"string",
            "description":"Dimension type for a matrix dimension.",
            "nullable":false,
            "x-queryable":true
        },
        "ComparisonOperator":{
            "title":"Comparison",
            "maxLength":"30",
            "type":"string",
            "description":"Comparison operator for the matrix dimension. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_OPERATORS.",
            "nullable":true,
            "default":"E",
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence for the matrix dimension.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "NullInRuleIsWildCard":{
            "title":"Null Is Wildcard",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CompareToEntity":{
            "title":"Compare to Entity",
            "maxLength":"80",
            "type":"string",
            "description":"Entity that's used along with the Compare To Attribute for comparison for the matrix dimension evaluation.",
            "nullable":true,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DomainType":{
            "title":"Domain Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of domain for the matrix dimension. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":false,
            "default":"NONE",
            "x-queryable":true
        },
        "IsRequired":{
            "title":"Required",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "DefaultValueDate":{
            "title":"Default Value",
            "type":"string",
            "description":"Default date for the matrix dimension.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MatrixClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix class for the matrix dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DefaultValueNumber":{
            "title":"Default Value",
            "type":"number",
            "description":"Default number for the matrix dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of data for the matrix dimension. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":false,
            "default":"STRING",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CompareToAttr":{
            "title":"Compare to Attribute",
            "maxLength":"80",
            "type":"string",
            "description":"Attribute that's used along with the Compare To Entity for comparison during matrix dimension evaluation.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultIsFixedValue":{
            "title":"Default Is Fixed Value",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "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: matrix dimension can be null. N: matrix dimension can't be null. This attribute doesn't have a default value.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "DefaultValueString":{
            "title":"Default Value",
            "maxLength":"100",
            "type":"string",
            "description":"Default string for the matrix dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "ShowDefaultValueDimensionInRules":{
            "title":"Fixed Column Is Displayed",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "SourceCodeName":{
            "title":"Source Code Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the source code for the matrix dimension.",
            "nullable":true,
            "x-queryable":true
        },
        "MatrixDimensionName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the matrix dimension associated with the matrix class.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultValueTimestamp":{
            "title":"Default Value",
            "type":"string",
            "description":"Default timestamp value for the matrix dimension.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Most recent date and time when the application updated the record.",
            "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