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

{
  "sections": [
    "title",
    "description",
    "fields"
  ],
  "title": "EnblProgramTaskDefinition - Data API",
  "description": "Represents an outcome, a milestone, or an exercise in an Enablement program. A program task is also known as a program item. This object is available in API version 60.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CompositeMilestoneType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The type of logic to use for evaluating the activity from two Enablement measures in a composite milestone.Possible values are: Addition Division Percentage Available in API version 61.0 and later."
    },
    "CustomEnblPgmTaskSubCategoryId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the EnblProgramTaskSubCategory record associated with a custom exercise type. This field is required when the TaskSubCategory field’s value is CustomExercise.This field is a relationship field. Available in API version 62.0 and later.",
      "relationship_name": "CustomEnblPgmTaskSubCategory",
      "relationship_type": "Lookup",
      "refers_to": "EnblProgramTaskSubCategory"
    },
    "Day": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "The day of the program when the item is due, relative to the program's start date. For example, if a user is expected to complete an exercise where they watch a product demo by day 2, this field’s value is 2. For an outcome, this field specifies the number of days the full program takes. For example, if your program lasts 60 days, the value of this field is 60 for the outcome. This field’s value contributes to the program’s due date that users see when they take the program."
    },
    "Description": {
      "type": "textarea",
      "properties": "Create",
      "description": "A summary of the outcome, milestone, or exercise that’s visible to users when they take the program."
    },
    "EnablementProgramId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the Enablement program that contains the outcome, milestone, or exercise. This field is a relationship field.",
      "relationship_name": "EnablementProgram",
      "relationship_type": "Lookup",
      "refers_to": "EnablementProgram"
    },
    "EnblProgramSectionId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of an optional program section that contains the milestone or exercise. This field is a relationship field.",
      "relationship_name": "EnblProgramSection",
      "relationship_type": "Lookup",
      "refers_to": "EnblProgramSection"
    },
    "IsMilestoneAnOutcome": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the program item is the program’s final outcome (true) or an incremental milestone (false). The default value is false."
    },
    "LearningItemId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the learning item record for the outcome, milestone, or exercise. This field is a relationship field.",
      "relationship_name": "LearningItem",
      "relationship_type": "Lookup",
      "refers_to": "LearningItem"
    },
    "MilestoneTarget": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The target value for a user to achieve to get credit for completing the outcome or milestone. The unit depends on the specific measure used with the outcome or milestone. For example, if the measure is the dollar amount of all closed opportunities, then the field value is measured in dollars."
    },
    "MinimumSampleSize": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of records to evaluate when calculating progress for an outcome or milestone that uses an average-based measure. Use this field with MilestoneTarget. For example, if you want users to achieve an average deal size of $50,000 after closing 4 deals, then this field’s value is 4 and MilestoneTarget is 50000."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "The title of the outcome, milestone, or exercise that’s visible to users when they take the program."
    },
    "SequenceNumber": {
      "type": "int",
      "properties": "Filter, Group, Sort",
      "description": "A number that specifies the order of the milestone or exercise, relative to other milestones or exercises that have the same due date in the program or in the same section, starting at 0. This number determines the order of items that users see for that day in the program."
    },
    "StandardCustomExerciseType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Reserved for future use."
    },
    "TaskCategory": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The type of program item. Possible values are: Exercise Milestone Milestone is used for both the program’s final outcome and incremental milestones."
    },
    "TaskSubCategory": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The type of exercise. This value determines the content associated with the exercise. For example, if the field value is Video, the exercise must reference video content from the Enablement workspace in the Digital Experiences app. The LearningItemId field specifies the reference to that video content. Possible values are: ActionItem AudioRecording CustomExercise—Available in API version 62.0 and later. Document FeedbackRequest Other OtherExercise ScheduledEvent StandardCustomExercise—Reserved for future use. TextLesson Trailhead Video"
    }
  }
}