Jump to

• Request
• Response

Gets a collection of rules and participants.

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRulesByParticipant

Request

Query Parameters

• 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
  
  

  • ByParticipantIdFinder Finds the rules assigned to a participant using the participant identifier.
    Finder Variables
    • b_participant_id; integer; The unique identifier of the participant assigned to a rule.
  • ByParticipantNameFinder Finds the rules assigned to a participant using the participant name.
    Finder Variables
    • b_participant_name; string; The name of the participant assigned to a rule.
  • ByPartyIdFinder Finds the rules assigned to a participant using the party identifier.
    Finder Variables
    • b_party_id; integer; The unique identifier of the party record of the participant assigned to a rule.
  • PrimaryKey Finds the rules belonging to a participant based on the primary key.
    Finder Variables
    • RuleAssignmentId; integer; The unique identifier of the rule assignment record which associates a participant to a 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:
  

  • ActiveFlag; boolean; Indicates whether the participant is active.
  • AssignedObjectId; integer; The unique identifier of the object assigned to the rule.
  • AssignedObjectType; string; The type of the object assigned to the rule.
  • AssignmentEndDate; string; The end date of the rule assignment.
  • AssignmentStartDate; string; The start date of the rule assignment.
  • Description; string; The description of the rule assigned to the participant.
  • EmailAddress; string; The email address of the participant assigned to the rule.
  • EnabledFlag; boolean; Indicates whether the rule is enabled.
  • NumberOfWinners; integer; The number rules that can win in the rule hierarchy.
  • OrgId; integer; The unique business unit identifier of the rule assigned to participants.
  • ParentRuleId; integer; The unique identifier of the parent rule.
  • ParticipantEndDate; string; The end date of the participant assigned to the rule.
  • ParticipantId; integer; The unique identifier of the participant assigned to a rule.
  • ParticipantName; string; The name of the participant assigned to a rule.
  • ParticipantStartDate; string; The start date of the participant assigned to the rule.
  • PartyId; integer; The unique identifier of the party record of the participant assigned to a rule.
  • Rank; integer; The rank of the rule.
  • RevenueType; string; The revenue type associated to the participant rule assignment.
  • RoleId; integer; The unique role identifier of the participant assigned to the rule.
  • RuleAssignmentId; integer; The unique identifier of the rule assignment record which associates a participant to a rule.
  • RuleId; integer; The unique identifier of the rule assigned to the participant.
  • RuleName; string; The name of the rule assigned to the participant.
  • RuleNumber; string; The number of the rule assigned to the participant.
  • RulesEndDate; string; The end date of the rule assigned to the participant.
  • RulesStartDate; string; The start date of the rule assigned to the participant.
  • SplitPct; number; Indicates how much percentage of credit to assign to the participant in a rule.
  • UsageId; integer; The unique identifier of the rule usage to signify the type of the rule.
  • UsageName; string; The name of the rule usage to signify the type of the rule.
• 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: string
  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: string
  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 : incentiveCompensationRulesByParticipant

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRulesByParticipant-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object incentiveCompensationRulesByParticipant-item-response

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

Type: object

Show Source

• ActiveFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the participant is active.
• AssignedObjectId: integer (int64)
  Read Only: true

  The unique identifier of the object assigned to the rule.
• AssignedObjectType: string
  Read Only: true

  Maximum Length: 30

  The type of the object assigned to the rule.
• AssignmentEndDate: string (date)
  Read Only: true

  The end date of the rule assignment.
• AssignmentStartDate: string (date)
  Read Only: true

  The start date of the rule assignment.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The description of the rule assigned to the participant.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the participant assigned to the rule.
• EnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the rule is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfWinners: integer (int32)
  Read Only: true

  The number rules that can win in the rule hierarchy.
• OrgId: integer (int64)
  Read Only: true

  The unique business unit identifier of the rule assigned to participants.
• ParentRuleId: integer (int64)
  Read Only: true

  The unique identifier of the parent rule.
• ParticipantEndDate: string (date)
  Read Only: true

  The end date of the participant assigned to the rule.
• ParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the participant assigned to a rule.
• ParticipantName: string
  Read Only: true

  Maximum Length: 360

  The name of the participant assigned to a rule.
• ParticipantStartDate: string (date)
  Read Only: true

  The start date of the participant assigned to the rule.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party record of the participant assigned to a rule.
• Rank: integer (int64)
  Read Only: true

  The rank of the rule.
• RevenueType: string
  Read Only: true

  Maximum Length: 30

  The revenue type associated to the participant rule assignment.
• RoleId: integer (int64)
  Read Only: true

  The unique role identifier of the participant assigned to the rule.
• RuleAssignmentId: integer (int64)
  Read Only: true

  The unique identifier of the rule assignment record which associates a participant to a rule.
• RuleId: integer
  Read Only: true

  The unique identifier of the rule assigned to the participant.
• RuleName: string
  Read Only: true

  Maximum Length: 160

  The name of the rule assigned to the participant.
• RuleNumber: string
  Read Only: true

  Maximum Length: 30

  The number of the rule assigned to the participant.
• RulesEndDate: string (date)
  Read Only: true

  The end date of the rule assigned to the participant.
• RulesStartDate: string (date)
  Read Only: true

  The start date of the rule assigned to the participant.
• SplitPct: number
  Read Only: true

  Indicates how much percentage of credit to assign to the participant in a rule.
• UsageId: integer (int64)
  Read Only: true

  The unique identifier of the rule usage to signify the type of the rule.
• UsageName: string
  Read Only: true

  Maximum Length: 160

  The name of the rule usage to signify the type of the rule.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the participant is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object assigned to the rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignedObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the object assigned to the rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "type":"string",
            "description":"The end date of the rule assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "type":"string",
            "description":"The start date of the rule assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the rule assigned to the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the participant assigned to the rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfWinners":{
            "type":"integer",
            "description":"The number rules that can win in the rule hierarchy.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique business unit identifier of the rule assigned to participants.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentRuleId":{
            "type":"integer",
            "description":"The unique identifier of the parent rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantEndDate":{
            "type":"string",
            "description":"The end date of the participant assigned to the rule.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant assigned to a rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant assigned to a rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantStartDate":{
            "type":"string",
            "description":"The start date of the participant assigned to the rule.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party record of the participant assigned to a rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Rank":{
            "type":"integer",
            "description":"The rank of the rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The revenue type associated to the participant rule assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique role identifier of the participant assigned to the rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of the rule assignment record which associates a participant to a rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule assigned to the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleName":{
            "maxLength":160,
            "type":"string",
            "description":"The name of the rule assigned to the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The number of the rule assigned to the participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RulesEndDate":{
            "type":"string",
            "description":"The end date of the rule assigned to the participant.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RulesStartDate":{
            "type":"string",
            "description":"The start date of the rule assigned to the participant.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"Indicates how much percentage of credit to assign to the participant in a rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageId":{
            "type":"integer",
            "description":"The unique identifier of the rule usage to signify the type of the rule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UsageName":{
            "maxLength":160,
            "type":"string",
            "description":"The name of the rule usage to signify the type of the rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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