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

127 lines
6.5 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "WorkThanks - Data API",
"description": "Represents the source and message of a thanks post.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"FeedItemId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the FeedItem related to the thanks badge. This is a relationship field.",
"relationship_name": "FeedItem",
"relationship_type": "Lookup",
"refers_to": "FeedItem"
},
"GiverId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "Salesforce user ID for the giver of the Thanks record. This is a relationship field.",
"relationship_name": "Giver",
"relationship_type": "Lookup",
"refers_to": "User"
},
"Message": {
"type": "textarea",
"properties": "Create",
"description": "Message associated with the Thanks record.",
"required": true
},
"NetworkId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the community that this WorkThanks is associated with. This field is available only if digital experiences is enabled in your org."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Salesforce user ID for the owner of the badge record (typically the same user as the giver of the record). This is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
}
},
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **WorkThanksChangeEvent (API version 62.0)**: Change events are available for the object.\n- **WorkThanksOwnerSharingRule**: Sharing rules are available for the object.\n- **WorkThanksShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n<complexType name=\"WorkThanks\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Badges\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"FeedItem\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FeedItem\"/>\n <element name=\"FeedItemId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Giver\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"GiverId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Message\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"FeedItemId": {
"field_label": "Feed Item ID",
"type": "reference",
"length": "18"
},
"GiverId": {
"field_label": "User ID",
"type": "reference",
"length": "18"
},
"Id": {
"field_label": "Thanks ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Message": {
"field_label": "Message",
"type": "textarea",
"length": "4000"
},
"NetworkId": {
"field_label": "Network ID",
"type": "reference",
"length": "18"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}