Jump to

• Request
• Response

Get a rule assignment

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments/{RuleAssignmentId}

Request

Path Parameters

• RuleAssignmentId(required): integer(int64)
  The unique identifier of rule assignment. This value is generated during a create action.
• 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-RuleAssignments-item-response

Type: object

Show Source

• AssignedObjectId: integer (int64)
  Title: Name

  The unique identifier of the assigned object.
• AssignedObjectName: string
  Read Only: true

  The name of the assigned object.
• AssignedObjectType: string
  Title: Type

  Maximum Length: 30

  The type of assignment, such as participant, role, team, group, or eligible category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the rule assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date when the rule assignment was created.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.
• GroupMemberCreditFlag: boolean
  Title: Receive direct credit

  Maximum Length: 1

  Default Value: false

  Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the rule assignment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the rule assignment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the rule assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• RevenueType: string
  Title: Revenue Type

  Maximum Length: 30

  Default Value: REVENUE

  The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RoleId: integer (int64)
  Title: Role

  The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.
• RoleName: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  The name of the role associated with the participant assigned to the rule.
• RollupFlag: boolean
  Title: Roll Up to Parents

  Maximum Length: 1

  Default Value: false

  Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.
• RuleAssignmentId: integer (int64)
  Read Only: true

  The unique identifier of rule assignment. This value is generated during a create action.
• RuleId: integer (int64)
  Title: Parent

  The unique identifier of the rule.
• SplitPercent: number
  Title: Split Percent

  Default Value: 100

  The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.
• SummaryFlag: boolean
  Title: Summarize rollups

  Maximum Length: 1

  Default Value: false

  Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the rule assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectName":{
            "type":"string",
            "description":"The name of the assigned object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the rule assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Roll Up to Parents",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rule assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the assigned object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupMemberCreditFlag":{
            "title":"Receive direct credit",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role associated with the participant assigned to the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPercent":{
            "title":"Split Percent",
            "type":"number",
            "description":"The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.",
            "nullable":true,
            "default":"100",
            "x-queryable":true
        },
        "RuleAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of rule assignment. This value is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignedObjectType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of assignment, such as participant, role, team, group, or eligible category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummaryFlag":{
            "title":"Summarize rollups",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueType":{
            "title":"Revenue Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the rule assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the rule assignment.",
            "nullable":true,
            "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."
        }
    }
}

Links

AssignedObjectTypeAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_RS_ASSIGNED_OBJECT_TYPE%2CLookupCode%3DELIGIBLE_CATEGORY

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.

GroupMemberCreditFlagLookupViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO

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.

ParticipantsLovViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/creditCategories

The credit categories resource is used to view, create, update, and delete a credit category and its details. Credit categories provide the eligibility of a participant, a team, or a manager to receive credit for a transaction.

RollupFlagLookupViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO

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.

RollupRevenueTypeAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_RS_REVENUE_TYPE

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.

SummaryFlagLookupViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO

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