afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/WorkRewardFund.json

71 lines
3.5 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects"
],
"title": "WorkRewardFund - Data API",
"description": "Represents a Reward Fund and describes the Reward Fund attributes.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"IsActive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Indicates whether the WorkRewardFund is active (true) or not (false)."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time stamp that indicates when the current user last viewed a record that is related to this WorkRewardFund."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The time stamp that indicates when the current user last viewed this WorkRewardFund. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "Name of the Reward Fund.",
"required": true
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Salesforce unique ID of User who is the Owner of the WorkRewardFund record."
},
"RewardFundTypeId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort, Update",
"description": "Salesforce unique ID of the WorkRewardFundType that is associated with the WorkRewardFund."
},
"TotalCodeCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Total reward codes that are available in the WorkRewardFund. Derived from WorkReward records that are associated with the WorkRewardFund."
},
"Type": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "RewardType of the WorkRewardFund. Default is Amazon.com."
},
"UsedCodeCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Total reward codes that are used in the WorkRewardFund. Derived from the total assigned WorkReward records that are associated with the WorkRewardFund."
},
"Value": {
"type": "currency",
"properties": "Create, Filter, Sort, Update",
"description": "Value of each of the reward codes in the WorkRewardFund."
}
},
"special_access_rules": "To use the Rewards feature, including WorkRewardFund and WorkReward, you must have the Reward permission enabled. To create Rewards, the user must have Create on WorkRewardFund, which is not a standard permission.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **WorkRewardFundFeed**: Feed tracking is available for the object.\n- **WorkRewardFundHistory**: History is available for tracked fields of the object.\n- **WorkRewardFundOwnerSharingRule**: The original WDC feature is unavailable as of Spring '22. This object isn't available as of API version 54.0. For more information, see Phased WDC (legacy Work.com) Feature Retirement.\n- **WorkRewardFundShare**: Sharing rules are available for the object."
}