Jump to

• Request
• Response
• Examples

Get all matrix rules

get

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

Request

Path Parameters

• MatrixId(required): integer(int64)
  Value that uniquely identifies the pricing matrix header.

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:
  
  

  • FindMatrixRules: Finds matrix rules according to dimensions and values.
    Finder Variables:
    • Dimension1; string; Name of the first dimension in the matrix.
    • Dimension10; string; Name of the tenth dimension in the matrix.
    • Dimension10KeyValue; string; Value that uniquely identifies the tenth dimension value in the matrix.
    • Dimension10Value; string; Value of the tenth dimension in the matrix.
    • Dimension11; string; Name of the eleventh dimension in the matrix.
    • Dimension11KeyValue; string; Value that uniquely identifies the eleventh dimension value in the matrix.
    • Dimension11Value; string; Value of the eleventh dimension in the matrix.
    • Dimension12; string; Name of the twelfth dimension in the matrix.
    • Dimension12KeyValue; string; Value that uniquely identifies the twelfth dimension value in the matrix.
    • Dimension12Value; string; Value of the twelfth dimension in the matrix.
    • Dimension13; string; Name of the thirteenth dimension in the matrix.
    • Dimension13KeyValue; string; Value that uniquely identifies the thirteenth dimension value in the matrix.
    • Dimension13Value; string; Value of the thirteenth dimension in the matrix.
    • Dimension14; string; Name of the fourteenth dimension in the matrix.
    • Dimension14KeyValue; string; Value that uniquely identifies the fourteenth dimension value in the matrix.
    • Dimension14Value; string; Value of the fourteenth dimension in the matrix.
    • Dimension15; string; Name of the fifteenth dimension in the matrix.
    • Dimension15KeyValue; string; Value that uniquely identifies the fifteenth dimension value in the matrix.
    • Dimension15Value; string; Value of the fifteenth dimension in the matrix.
    • Dimension16; string; Name of the sixteenth dimension in the matrix.
    • Dimension16KeyValue; string; Value that uniquely identifies the sixteenth dimension value in the matrix.
    • Dimension16Value; string; Value of the sixteenth dimension in the matrix.
    • Dimension17; string; Name of the seventeenth dimension in the matrix.
    • Dimension17KeyValue; string; Value that uniquely identifies the seventeenth dimension value in the matrix.
    • Dimension17Value; string; Value of the seventeenth dimension in the matrix.
    • Dimension18; string; Name of the eighteenth dimension in the matrix.
    • Dimension18KeyValue; string; Value that uniquely identifies the eighteenth dimension value in the matrix.
    • Dimension18Value; string; Value of the eighteenth dimension in the matrix.
    • Dimension19; string; Name of the nineteenth dimension in the matrix.
    • Dimension19KeyValue; string; Value that uniquely identifies the nineteenth dimension value in the matrix.
    • Dimension19Value; string; Value of the nineteenth dimension in the matrix.
    • Dimension1KeyValue; string; Value that uniquely identifies the first dimension value in the matrix.
    • Dimension1Value; string; Value of the first dimension in the matrix.
    • Dimension2; string; Name of the second dimension in the matrix.
    • Dimension20; string; Name of the twentieth dimension in the matrix.
    • Dimension20KeyValue; string; Value that uniquely identifies the twentieth dimension value in the matrix.
    • Dimension20Value; string; Value of the twentieth dimension in the matrix.
    • Dimension21; string; Name of the twenty-first dimension in the matrix.
    • Dimension21KeyValue; string; Value that uniquely identifies the twenty-first dimension value in the matrix.
    • Dimension21Value; string; Value of the twenty-first dimension in the matrix.
    • Dimension22; string; Name of the twenty-second dimension in the matrix.
    • Dimension22KeyValue; string; Value that uniquely identifies the twenty-second dimension value in the matrix.
    • Dimension22Value; string; Value of the twenty-second dimension in the matrix.
    • Dimension23; string; Name of the twenty-third dimension in the matrix.
    • Dimension23KeyValue; string; Value that uniquely identifies the twenty-third dimension value in the matrix.
    • Dimension23Value; string; Value of the twenty-third dimension in the matrix.
    • Dimension24; string; Name of the twenty-fourth dimension in the matrix.
    • Dimension24KeyValue; string; Value that uniquely identifies the twenty-fourth dimension value in the matrix.
    • Dimension24Value; string; Value of the twenty-fourth dimension in the matrix.
    • Dimension25; string; Name of the twenty-fifth dimension in the matrix.
    • Dimension25KeyValue; string; Value that uniquely identifies the twenty-fifth dimension value in the matrix.
    • Dimension25Value; string; Value of the twenty-fifth dimension in the matrix.
    • Dimension2KeyValue; string; Value that uniquely identifies the second dimension value in the matrix.
    • Dimension2Value; string; Value of the second dimension in the matrix.
    • Dimension3; string; Name of the third dimension in the matrix.
    • Dimension3KeyValue; string; Value that uniquely identifies the third dimension value in the matrix.
    • Dimension3Value; string; Value of the third dimension in the matrix.
    • Dimension4; string; Name of the fourth dimension in the matrix.
    • Dimension4KeyValue; string; Value that uniquely identifies the fourth dimension value in the matrix.
    • Dimension4Value; string; Value of the fourth dimension in the matrix.
    • Dimension5; string; Name of the fifth dimension in the matrix.
    • Dimension5KeyValue; string; Value that uniquely identifies the fifth dimension value in the matrix.
    • Dimension5Value; string; Value of the fifth dimension in the matrix.
    • Dimension6; string; Name of the sixth dimension in the matrix.
    • Dimension6KeyValue; string; Value that uniquely identifies the sixth dimension value in the matrix.
    • Dimension6Value; string; Value of the sixth dimension in the matrix.
    • Dimension7; string; Name of the seventh dimension in the matrix.
    • Dimension7KeyValue; string; Value that uniquely identifies the seventh dimension value in the matrix.
    • Dimension7Value; string; Value of the seventh dimension in the matrix.
    • Dimension8; string; Name of the eighth dimension in the matrix.
    • Dimension8KeyValue; string; Value that uniquely identifies the eighth dimension value in the matrix.
    • Dimension8Value; string; Value of the eighth dimension in the matrix.
    • Dimension9; string; Name of the ninth dimension in the matrix.
    • Dimension9KeyValue; string; Value that uniquely identifies the ninth dimension value in the matrix.
    • Dimension9Value; string; Value of the ninth dimension in the matrix.
  • PrimaryKey: Finds matrix rules according to the primary key.
    Finder Variables:
    • MatrixRuleId; integer; Value that uniquely identifies the matrix rule.
• 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:
  

  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the record was created.
  • Dimension1; string; Name of the first dimension in the matrix.
  • Dimension10; string; Name of the tenth dimension in the matrix.
  • Dimension10KeyValue; string; Value that uniquely identifies the tenth dimension value in the matrix.
  • Dimension10Value; string; Value of the tenth dimension in the matrix.
  • Dimension11; string; Name of the eleventh dimension in the matrix.
  • Dimension11KeyValue; string; Value that uniquely identifies the eleventh dimension value in the matrix.
  • Dimension11Value; string; Value of the eleventh dimension in the matrix.
  • Dimension12; string; Name of the twelfth dimension in the matrix.
  • Dimension12KeyValue; string; Value that uniquely identifies the twelfth dimension value in the matrix.
  • Dimension12Value; string; Value of the twelfth dimension in the matrix.
  • Dimension13; string; Name of the thirteenth dimension in the matrix.
  • Dimension13KeyValue; string; Value that uniquely identifies the thirteenth dimension value in the matrix.
  • Dimension13Value; string; Value of the thirteenth dimension in the matrix.
  • Dimension14; string; Name of the fourteenth dimension in the matrix.
  • Dimension14KeyValue; string; Value that uniquely identifies the fourteenth dimension value in the matrix.
  • Dimension14Value; string; Value of the fourteenth dimension in the matrix.
  • Dimension15; string; Name of the fifteenth dimension in the matrix.
  • Dimension15KeyValue; string; Value that uniquely identifies the fifteenth dimension value in the matrix.
  • Dimension15Value; string; Value of the fifteenth dimension in the matrix.
  • Dimension16; string; Name of the sixteenth dimension in the matrix.
  • Dimension16KeyValue; string; Value that uniquely identifies the sixteenth dimension value in the matrix.
  • Dimension16Value; string; Value of the sixteenth dimension in the matrix.
  • Dimension17; string; Name of the seventeenth dimension in the matrix.
  • Dimension17KeyValue; string; Value that uniquely identifies the seventeenth dimension value in the matrix.
  • Dimension17Value; string; Value of the seventeenth dimension in the matrix.
  • Dimension18; string; Name of the eighteenth dimension in the matrix.
  • Dimension18KeyValue; string; Value that uniquely identifies the eighteenth dimension value in the matrix.
  • Dimension18Value; string; Value of the eighteenth dimension in the matrix.
  • Dimension19; string; Name of the nineteenth dimension in the matrix.
  • Dimension19KeyValue; string; Value that uniquely identifies the nineteenth dimension value in the matrix.
  • Dimension19Value; string; Value of the nineteenth dimension in the matrix.
  • Dimension1KeyValue; string; Value that uniquely identifies the first dimension value in the matrix.
  • Dimension1Value; string; Value of the first dimension in the matrix.
  • Dimension2; string; Name of the second dimension in the matrix.
  • Dimension20; string; Name of the twentieth dimension in the matrix.
  • Dimension20KeyValue; string; Value that uniquely identifies the twentieth dimension value in the matrix.
  • Dimension20Value; string; Value of the twentieth dimension in the matrix.
  • Dimension21; string; Name of the twenty-first dimension in the matrix.
  • Dimension21KeyValue; string; Value that uniquely identifies the twenty-first dimension value in the matrix.
  • Dimension21Value; string; Value of the twenty-first dimension in the matrix.
  • Dimension22; string; Name of the twenty-second dimension in the matrix.
  • Dimension22KeyValue; string; Value that uniquely identifies the twenty-second dimension value in the matrix.
  • Dimension22Value; string; Value of the twenty-second dimension in the matrix.
  • Dimension23; string; Name of the twenty-third dimension in the matrix.
  • Dimension23KeyValue; string; Value that uniquely identifies the twenty-third dimension value in the matrix.
  • Dimension23Value; string; Value of the twenty-third dimension in the matrix.
  • Dimension24; string; Name of the twenty-fourth dimension in the matrix.
  • Dimension24KeyValue; string; Value that uniquely identifies the twenty-fourth dimension value in the matrix.
  • Dimension24Value; string; Value of the twenty-fourth dimension in the matrix.
  • Dimension25; string; Name of the twenty-fifth dimension in the matrix.
  • Dimension25KeyValue; string; Value that uniquely identifies the twenty-fifth dimension value in the matrix.
  • Dimension25Value; string; Value of the twenty-fifth dimension in the matrix.
  • Dimension2KeyValue; string; Value that uniquely identifies the second dimension value in the matrix.
  • Dimension2Value; string; Value of the second dimension in the matrix.
  • Dimension3; string; Name of the third dimension in the matrix.
  • Dimension3KeyValue; string; Value that uniquely identifies the third dimension value in the matrix.
  • Dimension3Value; string; Value of the third dimension in the matrix.
  • Dimension4; string; Name of the fourth dimension in the matrix.
  • Dimension4KeyValue; string; Value that uniquely identifies the fourth dimension value in the matrix.
  • Dimension4Value; string; Value of the fourth dimension in the matrix.
  • Dimension5; string; Name of the fifth dimension in the matrix.
  • Dimension5KeyValue; string; Value that uniquely identifies the fifth dimension value in the matrix.
  • Dimension5Value; string; Value of the fifth dimension in the matrix.
  • Dimension6; string; Name of the sixth dimension in the matrix.
  • Dimension6KeyValue; string; Value that uniquely identifies the sixth dimension value in the matrix.
  • Dimension6Value; string; Value of the sixth dimension in the matrix.
  • Dimension7; string; Name of the seventh dimension in the matrix.
  • Dimension7KeyValue; string; Value that uniquely identifies the seventh dimension value in the matrix.
  • Dimension7Value; string; Value of the seventh dimension in the matrix.
  • Dimension8; string; Name of the eighth dimension in the matrix.
  • Dimension8KeyValue; string; Value that uniquely identifies the eighth dimension value in the matrix.
  • Dimension8Value; string; Value of the eighth dimension in the matrix.
  • Dimension9; string; Name of the ninth dimension in the matrix.
  • Dimension9KeyValue; string; Value that uniquely identifies the ninth dimension value in the matrix.
  • Dimension9Value; string; Value of the ninth dimension in the matrix.
  • LastUpdateDate; string; Date and time when the record was most recently updated.
  • LastUpdatedBy; string; User who most recently updated the record.
  • MatrixId; integer; Value that uniquely identifies the matrix header.
  • MatrixRuleId; integer; Value that uniquely identifies the matrix rule.
  • RuleEndDate; string; Date when the matrix rule becomes inactive.
  • RuleStartDate; string; Date when the matrix rule becomes active.
• 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 : pricingMatrixes-rules

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/pricingMatrixes-rules-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object pricingMatrixes-rules-item-response

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

Type: object

Show Source

• 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.
• Dimension1: string
  Name of the first dimension in the matrix.
• Dimension10: string
  Name of the tenth dimension in the matrix.
• Dimension10KeyValue: string
  Value that uniquely identifies the tenth dimension value in the matrix.
• Dimension10Value: string
  Value of the tenth dimension in the matrix.
• Dimension11: string
  Name of the eleventh dimension in the matrix.
• Dimension11KeyValue: string
  Value that uniquely identifies the eleventh dimension value in the matrix.
• Dimension11Value: string
  Value of the eleventh dimension in the matrix.
• Dimension12: string
  Name of the twelfth dimension in the matrix.
• Dimension12KeyValue: string
  Value that uniquely identifies the twelfth dimension value in the matrix.
• Dimension12Value: string
  Value of the twelfth dimension in the matrix.
• Dimension13: string
  Name of the thirteenth dimension in the matrix.
• Dimension13KeyValue: string
  Value that uniquely identifies the thirteenth dimension value in the matrix.
• Dimension13Value: string
  Value of the thirteenth dimension in the matrix.
• Dimension14: string
  Name of the fourteenth dimension in the matrix.
• Dimension14KeyValue: string
  Value that uniquely identifies the fourteenth dimension value in the matrix.
• Dimension14Value: string
  Value of the fourteenth dimension in the matrix.
• Dimension15: string
  Name of the fifteenth dimension in the matrix.
• Dimension15KeyValue: string
  Value that uniquely identifies the fifteenth dimension value in the matrix.
• Dimension15Value: string
  Value of the fifteenth dimension in the matrix.
• Dimension16: string
  Name of the sixteenth dimension in the matrix.
• Dimension16KeyValue: string
  Value that uniquely identifies the sixteenth dimension value in the matrix.
• Dimension16Value: string
  Value of the sixteenth dimension in the matrix.
• Dimension17: string
  Name of the seventeenth dimension in the matrix.
• Dimension17KeyValue: string
  Value that uniquely identifies the seventeenth dimension value in the matrix.
• Dimension17Value: string
  Value of the seventeenth dimension in the matrix.
• Dimension18: string
  Name of the eighteenth dimension in the matrix.
• Dimension18KeyValue: string
  Value that uniquely identifies the eighteenth dimension value in the matrix.
• Dimension18Value: string
  Value of the eighteenth dimension in the matrix.
• Dimension19: string
  Name of the nineteenth dimension in the matrix.
• Dimension19KeyValue: string
  Value that uniquely identifies the nineteenth dimension value in the matrix.
• Dimension19Value: string
  Value of the nineteenth dimension in the matrix.
• Dimension1KeyValue: string
  Value that uniquely identifies the first dimension value in the matrix.
• Dimension1Value: string
  Value of the first dimension in the matrix.
• Dimension2: string
  Name of the second dimension in the matrix.
• Dimension20: string
  Name of the twentieth dimension in the matrix.
• Dimension20KeyValue: string
  Value that uniquely identifies the twentieth dimension value in the matrix.
• Dimension20Value: string
  Value of the twentieth dimension in the matrix.
• Dimension21: string
  Name of the twenty-first dimension in the matrix.
• Dimension21KeyValue: string
  Value that uniquely identifies the twenty-first dimension value in the matrix.
• Dimension21Value: string
  Value of the twenty-first dimension in the matrix.
• Dimension22: string
  Name of the twenty-second dimension in the matrix.
• Dimension22KeyValue: string
  Value that uniquely identifies the twenty-second dimension value in the matrix.
• Dimension22Value: string
  Value of the twenty-second dimension in the matrix.
• Dimension23: string
  Name of the twenty-third dimension in the matrix.
• Dimension23KeyValue: string
  Value that uniquely identifies the twenty-third dimension value in the matrix.
• Dimension23Value: string
  Value of the twenty-third dimension in the matrix.
• Dimension24: string
  Name of the twenty-fourth dimension in the matrix.
• Dimension24KeyValue: string
  Value that uniquely identifies the twenty-fourth dimension value in the matrix.
• Dimension24Value: string
  Value of the twenty-fourth dimension in the matrix.
• Dimension25: string
  Name of the twenty-fifth dimension in the matrix.
• Dimension25KeyValue: string
  Value that uniquely identifies the twenty-fifth dimension value in the matrix.
• Dimension25Value: string
  Value of the twenty-fifth dimension in the matrix.
• Dimension2KeyValue: string
  Value that uniquely identifies the second dimension value in the matrix.
• Dimension2Value: string
  Value of the second dimension in the matrix.
• Dimension3: string
  Name of the third dimension in the matrix.
• Dimension3KeyValue: string
  Value that uniquely identifies the third dimension value in the matrix.
• Dimension3Value: string
  Value of the third dimension in the matrix.
• Dimension4: string
  Name of the fourth dimension in the matrix.
• Dimension4KeyValue: string
  Value that uniquely identifies the fourth dimension value in the matrix.
• Dimension4Value: string
  Value of the fourth dimension in the matrix.
• Dimension5: string
  Name of the fifth dimension in the matrix.
• Dimension5KeyValue: string
  Value that uniquely identifies the fifth dimension value in the matrix.
• Dimension5Value: string
  Value of the fifth dimension in the matrix.
• Dimension6: string
  Name of the sixth dimension in the matrix.
• Dimension6KeyValue: string
  Value that uniquely identifies the sixth dimension value in the matrix.
• Dimension6Value: string
  Value of the sixth dimension in the matrix.
• Dimension7: string
  Name of the seventh dimension in the matrix.
• Dimension7KeyValue: string
  Value that uniquely identifies the seventh dimension value in the matrix.
• Dimension7Value: string
  Value of the seventh dimension in the matrix.
• Dimension8: string
  Name of the eighth dimension in the matrix.
• Dimension8KeyValue: string
  Value that uniquely identifies the eighth dimension value in the matrix.
• Dimension8Value: string
  Value of the eighth dimension in the matrix.
• Dimension9: string
  Name of the ninth dimension in the matrix.
• Dimension9KeyValue: string
  Value that uniquely identifies the ninth dimension value in the matrix.
• Dimension9Value: string
  Value of the ninth dimension in the matrix.
• 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.
• MatrixId: integer (int64)
  Read Only: true

  Value that uniquely identifies the matrix header.
• MatrixRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the matrix rule.
• RuleEndDate: string (date-time)
  Title: End Date

  Date when the matrix rule becomes inactive.
• RuleStartDate: string (date-time)
  Title: Start Date

  Date when the matrix rule becomes active.

{
    "type":"object",
    "properties":{
        "Dimension17KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the seventeenth dimension value in the matrix.",
            "nullable":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
        },
        "RuleEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the matrix rule becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension18Value":{
            "type":"string",
            "description":"Value of the eighteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension18KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension12Value":{
            "type":"string",
            "description":"Value of the twelfth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension12KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension19KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the nineteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension7Value":{
            "type":"string",
            "description":"Value of the seventh dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension7KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension20Value":{
            "type":"string",
            "description":"Value of the twentieth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension20KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension15KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fifteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension1Value":{
            "type":"string",
            "description":"Value of the first dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension1KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension19":{
            "type":"string",
            "description":"Name of the nineteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension18":{
            "type":"string",
            "description":"Name of the eighteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension5KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fifth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension17":{
            "type":"string",
            "description":"Name of the seventeenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension16":{
            "type":"string",
            "description":"Name of the sixteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension15":{
            "type":"string",
            "description":"Name of the fifteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension13KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the thirteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension14":{
            "type":"string",
            "description":"Name of the fourteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension21Value":{
            "type":"string",
            "description":"Value of the twenty-first dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension21KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension13":{
            "type":"string",
            "description":"Name of the thirteenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension13Value":{
            "type":"string",
            "description":"Value of the thirteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension13KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension7KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the seventh dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension12":{
            "type":"string",
            "description":"Name of the twelfth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension19Value":{
            "type":"string",
            "description":"Value of the nineteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension19KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension11":{
            "type":"string",
            "description":"Name of the eleventh dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Dimension2Value":{
            "type":"string",
            "description":"Value of the second dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension2KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension10":{
            "type":"string",
            "description":"Name of the tenth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension11KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eleventh dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Dimension24KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-fourth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension8Value":{
            "type":"string",
            "description":"Value of the eighth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension8KeyValue"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Dimension22Value":{
            "type":"string",
            "description":"Value of the twenty-second dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension22KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension25Value":{
            "type":"string",
            "description":"Value of the twenty-fifth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension25KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension2":{
            "type":"string",
            "description":"Name of the second dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension10KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the tenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension3":{
            "type":"string",
            "description":"Name of the third dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension22KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-second dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension4":{
            "type":"string",
            "description":"Name of the fourth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension5":{
            "type":"string",
            "description":"Name of the fifth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension1":{
            "type":"string",
            "description":"Name of the first dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension3Value":{
            "type":"string",
            "description":"Value of the third dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension3KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension6Value":{
            "type":"string",
            "description":"Value of the sixth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension6KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension6":{
            "type":"string",
            "description":"Name of the sixth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension17Value":{
            "type":"string",
            "description":"Value of the seventeenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension17KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension7":{
            "type":"string",
            "description":"Name of the seventh dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension3KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the third dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension8":{
            "type":"string",
            "description":"Name of the eighth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension9":{
            "type":"string",
            "description":"Name of the ninth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension14Value":{
            "type":"string",
            "description":"Value of the fourteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension14KeyValue"
                ]
            },
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dimension1KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the first dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension20KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twentieth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension11Value":{
            "type":"string",
            "description":"Value of the eleventh dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension11KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension15Value":{
            "type":"string",
            "description":"Value of the fifteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension15KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension16KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the sixteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension4Value":{
            "type":"string",
            "description":"Value of the fourth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension4KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension14KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fourteenth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension4KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the fourth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension23Value":{
            "type":"string",
            "description":"Value of the twenty-third dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension23KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension9Value":{
            "type":"string",
            "description":"Value of the ninth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension9KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension24Value":{
            "type":"string",
            "description":"Value of the twenty-fourth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension24KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension12KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twelfth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension10Value":{
            "type":"string",
            "description":"Value of the tenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension10KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension6KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the sixth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "MatrixRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Dimension16Value":{
            "type":"string",
            "description":"Value of the sixteenth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension16KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension8KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eighth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension5Value":{
            "type":"string",
            "description":"Value of the fifth dimension in the matrix.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Dimension5KeyValue"
                ]
            },
            "x-queryable":true
        },
        "Dimension9KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the ninth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension25KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-fifth dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the matrix rule becomes active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension23KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-third dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension25":{
            "type":"string",
            "description":"Name of the twenty-fifth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension24":{
            "type":"string",
            "description":"Name of the twenty-fourth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension23":{
            "type":"string",
            "description":"Name of the twenty-third dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension22":{
            "type":"string",
            "description":"Name of the twenty-second dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension21":{
            "type":"string",
            "description":"Name of the twenty-first dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension21KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the twenty-first dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension2KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the second dimension value in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension20":{
            "type":"string",
            "description":"Name of the twentieth dimension in the matrix.",
            "nullable":true,
            "x-queryable":true
        },
        "Dimension18KeyValue":{
            "type":"string",
            "description":"Value that uniquely identifies the eighteenth dimension value in the matrix.",
            "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

Examples

This example describes how to get all matrix rules.

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/rules"

Example Response Body

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

{
 "items": [
 {
    "MatrixRuleId": 300100149918374,
    "MatrixId": 300100149915150,
    "Dimension1": "CustomTS",
    "Dimension1Value": "CustomValue",
    "Dimension1KeyValue": "CustomValue",
    "Dimension2": "Adjustment Type",
    "Dimension2Value": "Discount amount",
    "Dimension2KeyValue": "DISCOUNT_AMOUNT",
    "Dimension3": "Adjustment Amount",
    "Dimension3Value": "10",
    "Dimension3KeyValue": "10",
    "Dimension4": "Adjustment Basis",
    "Dimension4Value": null,
    "Dimension4KeyValue": null,
    "Dimension5": null,
    "Dimension5Value": null,
    "Dimension5KeyValue": null,
    "Dimension6": null,
    "Dimension6Value": null,
    "Dimension6KeyValue": null,
    "Dimension7": null,
    "Dimension7Value": null,
    "Dimension7KeyValue": null,
    "Dimension8": null,
    "Dimension8Value": null,
    "Dimension8KeyValue": null,
    "Dimension9": null,
    "Dimension9Value": null,
    "Dimension9KeyValue": null,
    "Dimension10": null,
    "Dimension10Value": null,
    "Dimension10KeyValue": null,
    "CreationDate": "2018-05-21T06:08:06+00:00",
    "CreatedBy": "PRICING_MGR_OPERATIONS",
    "LastUpdateDate": "2018-05-21T06:08:06.137+00:00",
    "LastUpdatedBy": "PRICING_MGR_OPERATIONS"
 },
 {
    ...
 } 
 ]
}

Back to Top