Jump to

• Request
• Response

Get a qualifying attribute value

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria/{RuleAttributeId}/child/QualifyingAttributeValues/{RuleAttributeValueId}

Request

Path Parameters

• RuleAttributeId(required): integer(int64)
  The unique identifier of the rule attribute. This value is generated during a create action.
• RuleAttributeValueId(required): integer(int64)
  The unique identifier of the rule attribute value.
• RuleId(required): integer(int64)
  The unique identifier of a rule. This values is generated during a create action.

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

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 : incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response

Type: object

Show Source

• ComparisonOperator: string
  Title: Operator

  Maximum Length: 30

  Default Value: EQUAL_TO

  The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the qualifying attribute value.
• CreationDate: string (date-time)
  Read Only: true

  The date when the qualifying attribute value was created.
• HighValueCharacter: string
  Title: Character High Value

  Maximum Length: 360

  The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.
• HighValueNumber: integer
  Title: High Value Number

  The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the qualifying attribute value was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the qualifying attribute value.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the qualifying attribute value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowValueCharacter: string
  Title: Character Low Value

  Maximum Length: 360

  The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.
• LowValueCharacterCode: string
  Maximum Length: 360

  The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.
• LowValueCharacterId: integer (int64)
  The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.
• LowValueNumber: integer
  Title: Low Value Number

  The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• RuleAttributeId: integer (int64)
  The unique identifier of the rule attribute.
• RuleAttributeValueId: integer (int64)
  Read Only: true

  The unique identifier of the rule attribute value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the qualifying attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleAttributeValueId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the qualifying attribute value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ComparisonOperator":{
            "title":"Operator",
            "maxLength":"30",
            "type":"string",
            "description":"The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"EQUAL_TO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the qualifying attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HighValueNumber":{
            "title":"High Value Number",
            "type":"integer",
            "description":"The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HighValueCharacter":{
            "title":"Character High Value",
            "maxLength":"360",
            "type":"string",
            "description":"The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValueNumber":{
            "title":"Low Value Number",
            "type":"integer",
            "description":"The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValueCharacterCode":{
            "maxLength":"360",
            "type":"string",
            "description":"The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LowValueCharacterId":{
            "type":"integer",
            "description":"The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LowValueCharacter":{
            "title":"Character Low Value",
            "maxLength":"360",
            "type":"string",
            "description":"The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the qualifying attribute value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the qualifying attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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."
        }
    }
}

Links

AttributeValuesLookupViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleAttributeValuesLOV

Parameters:

• finder: ByRuleAttributeWithLookupIdRowFinder

The rule attribute values list of values resource is used to view the list of the values associated to a rule attribute or qualifier.

ComparisonOperatorsLovViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Back to Top