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

71 lines
3.2 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields"
],
"title": "LearningContent - Data API",
"description": "Represents a Trailhead or enablement site (myTrailhead) module assigned to a user in Workforce Engagement or Learning Paths. This object also represents a Trailhead module or video in an Enablement program exercise. This object is available in API version 54.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"ApiName": {
"type": "string",
"properties": "Filter, Group, Nillable",
"description": "The module's human-readable API name, such as pure-aloe-sales-strategies."
},
"AvailablePointCount": {
"type": "int",
"properties": "Group, Nillable",
"description": "The maximum points that a user can earn on their profile by completing the module. This value is the sum of points that the content creator assigns to the modules units."
},
"ContainsAssessmentType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist",
"description": "Specifies the type of assessment that the contents units include. Possible values are: MultipleChoiceQuiz—All the contents units have multiple-choice quizzes. HandsOnChallenge—At least one unit has a hands-on challenge."
},
"ContentType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist",
"description": "The type of content assigned to the user. Possible values are: All—The content is any supported type. Module—The content is a Trailhead or enablement site (myTrailhead) module. VideoLesson—The content is a video that's specified in the Enablement workspace in Digital Experiences and is used in an Enablement program."
},
"ContentUrl": {
"type": "url",
"properties": "Group, Nillable",
"description": "The absolute URL to the content, such as https://purealoe.my.trailhead.com/en/content/sales-team-enablement/modules/pure-aloe-sales-strategies."
},
"Description": {
"type": "string",
"properties": "Nillable",
"description": "The modules description."
},
"DurationCount": {
"type": "int",
"properties": "Group, Nillable",
"description": "The total time, in minutes, for a learner to complete all units in the module. This value is the sum of the estimated times that the content creator assigns to the modules units."
},
"ExternalId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The GUID that Trailhead uses to reference the module."
},
"ImageUrl": {
"type": "url",
"properties": "Group, Nillable",
"description": "The absolute URL to the modules badge art image file."
},
"IsPublic": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group",
"description": "Indicates whether the content is public Trailhead content (true) or private enablement site (myTrailhead) content (false). The default value is false."
},
"Title": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The modules title."
}
}
}