mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-08 00:10:29 +08:00
184 lines
8.8 KiB
JSON
184 lines
8.8 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "WorkBadge - Data API",
|
||
"description": "Represents information about who the badge was given to and which badge was given. A WorkBadge record is created for each recipient of a WorkBadgeDefinition.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"DefinitionId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "Salesforce unique ID for the given WorkBadgeDefinition record given. This is a relationship field.",
|
||
"relationship_name": "Definition",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "WorkBadgeDefinition",
|
||
"required": true
|
||
},
|
||
"Description": {
|
||
"type": "textarea",
|
||
"properties": "Nillable",
|
||
"description": "The description of the WorkBadgeDefinition."
|
||
},
|
||
"GiverId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The ID of the badge giver. Can’t be the same as RecipientId. This is a relationship field.",
|
||
"relationship_name": "Giver",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "User"
|
||
},
|
||
"ImageUrl": {
|
||
"type": "url",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The URL of the badge image."
|
||
},
|
||
"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 WorkBadge."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The time stamp that indicates when the current user last viewed this WorkBadge. If this value is null, this record might have been only referenced (LastReferencedDate) and not viewed."
|
||
},
|
||
"Message": {
|
||
"type": "textarea",
|
||
"properties": "Nillable",
|
||
"description": "The message accompanying the thanks badge."
|
||
},
|
||
"NetworkId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The ID of the community that this WorkBadge is associated with. This field is available only if digital experiences is enabled in your org."
|
||
},
|
||
"RecipientId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "Salesforce unique ID for User who is the Recipient of Badge. Can’t be the same as GiverId This is a relationship field.",
|
||
"relationship_name": "Recipient",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "User",
|
||
"required": true
|
||
},
|
||
"RewardId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Salesforce unique ID for Reward given with badge (if Reward Badge)"
|
||
},
|
||
"SourceId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "Salesforce unique ID for Thanks record referenced to this badge. This is a relationship field.",
|
||
"relationship_name": "Source",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "WorkThanks"
|
||
}
|
||
},
|
||
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **WorkBadgeChangeEvent (API version 62.0)**: Change events are 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=\"WorkBadge\">\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=\"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=\"Definition\" nillable=\"true\" minOccurs=\"0\" type=\"ens:WorkBadgeDefinition\"/>\n <element name=\"DefinitionId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"ImageUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Message\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Recipient\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"RecipientId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Source\" nillable=\"true\" minOccurs=\"0\" type=\"ens:WorkThanks\"/>\n <element name=\"SourceId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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"
|
||
},
|
||
"DefinitionId": {
|
||
"field_label": "Badge ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Description": {
|
||
"field_label": "Description",
|
||
"type": "textarea",
|
||
"length": "4000"
|
||
},
|
||
"GiverId": {
|
||
"field_label": "User ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"Id": {
|
||
"field_label": "Badge Received ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"ImageUrl": {
|
||
"field_label": "Image",
|
||
"type": "url",
|
||
"length": "255"
|
||
},
|
||
"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"
|
||
},
|
||
"LastReferencedDate": {
|
||
"field_label": "Last Referenced Date",
|
||
"type": "datetime"
|
||
},
|
||
"LastViewedDate": {
|
||
"field_label": "Last Viewed Date",
|
||
"type": "datetime"
|
||
},
|
||
"Message": {
|
||
"field_label": "Message",
|
||
"type": "textarea",
|
||
"length": "4000"
|
||
},
|
||
"NetworkId": {
|
||
"field_label": "Network ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"RecipientId": {
|
||
"field_label": "User ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"SourceId": {
|
||
"field_label": "Thanks ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length"
|
||
]
|
||
} |