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

60 lines
3.3 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields"
],
"title": "LearningPractice - Data API",
"description": "Represents a Feedback Request exercise in an Enablement program. Users can submit a sample of their work and request feedback from their peers and managers. Or, users can submit a video call and Einstein Coach generates feedback from the calls transcription. This object is available in API version 59.0 and later, but Einstein Coach feedback is available only in API version 61.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"Description": {
"type": "string",
"properties": "Filter, Sort",
"description": "Instructions to the user to provide context for completing the Feedback Request exercise. For example, Record yourself giving a sales pitch and request feedback from your peers."
},
"InviteeQuantity": {
"type": "int",
"properties": "Defaulted on create, Filter, Group, Nillable, Sort",
"description": "The number of peers or managers that the user is required to invite for giving feedback when Type is PeerFeedback. Each peer or manager receives an invitation to the assessment survey associated with the Feedback Request exercise.When Type is AIFeedback, this value is always 1."
},
"LearningItemId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the LearningItem record for the Feedback Request exercise. The value must be unique. This field is a relationship field.",
"relationship_name": "LearningItem",
"relationship_type": "Lookup",
"refers_to": "LearningItem"
},
"Name": {
"type": "string",
"properties": "Filter, Group, idLookup, Sort",
"description": "The title of the Feedback Request exercise. For example, Practice Your Sales Pitch."
},
"PromptTemplate": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The prompt template to use with this exercise when Type is AIFeedback.Available in API version 61.0 and later."
},
"SurveyId": {
"type": "reference",
"properties": "Filter, Group, Sort",
"description": "The ID of the assessment survey thats sent to peers and managers when Type is PeerFeedback. This field is a relationship field.",
"relationship_name": "Survey",
"relationship_type": "Lookup",
"refers_to": "Survey"
},
"Type": {
"type": "picklist",
"properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort",
"description": "The type of feedback used with this exercise. Possible values are: AIFeedback—Users submit a video call, and Einstein Coach generates feedback from the calls transcription. With this type, PromptTemplate is required. Available in API version 61.0 and later. PeerFeedback—Users submit a URL to a sample of their work, and select peers and managers to review their work. Selected peers and managers complete an assessment survey. With this type, SurveyId is required. Available in API version 61.0 and later. Survey—Users complete a survey as part of their enrolled employee enablement program. Available in API version 64.0 and later."
}
}
}