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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "EntityMilestone - Data API",
  "description": "Represents a required step in a customer support process on a work order. The Salesforce user interface uses the term “object milestone. This object is available in API version 37.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "ActualElapsedTimeInDays": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of days that it took to complete a milestone. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time) Note: To display this field, select Enable stopped time and actual elapsed time on the Entitlement Settings page and add the field to the object milestone page layout."
    },
    "ActualElapsedTimeInHrs": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of hours that it took to complete a milestone. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time) Note: To display this field, select Enable stopped time and actual elapsed time on the Entitlement Settings page and add the field to the object milestone page layout."
    },
    "ActualElapsedTimeInMins": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of minutes that it took to complete a milestone. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time) Note: To display this field, select Enable stopped time and actual elapsed time on the Entitlement Settings page and add the field to the object milestone page layout."
    },
    "BusinessHoursId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The business hours on the milestone. If business hours aren’t specified, the entitlement process business hours are used. If business hours are also not specified on the entitlement process, the business hours on the record are used."
    },
    "CompletionDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort, Update",
      "description": "The date and time the milestone was completed."
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Available only for orgs with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization."
    },
    "ElapsedTimeInDays": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of days it took to complete a milestone, including time during which the milestone was stopped. Automatically calculated to include the business hours on the record. Elapsed time is calculated only after the Completion Date field is populated. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time)."
    },
    "ElapsedTimeInHrs": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of hours it took to complete a milestone, including time during which the milestone was stopped. Automatically calculated to include the business hours on the record. Elapsed time is calculated only after the Completion Date field is populated. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time)."
    },
    "ElapsedTimeInMins": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of minutes it took to complete a milestone, including time during which the milestone was stopped. Automatically calculated to include the business hours on the record. Elapsed time is calculated only after the Completion Date field is populated. (Elapsed Time) – (Stopped Time) = (Actual Elapsed Time)."
    },
    "IsCompleted": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Green checkmark icon that indicates a milestone completion."
    },
    "IsViolated": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Red exclamation point icon that indicates a milestone violation."
    },
    "MilestoneTypeId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the milestone (for instance, First Response)."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, Sort, Update",
      "description": "The name of the milestone."
    },
    "ParentEntityId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The ID of the record—for example, a work order—that contains the milestone."
    },
    "SlaProcessId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The entitlement process associated with the milestone."
    },
    "StartDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort, Update",
      "description": "The date and time that milestone tracking started."
    },
    "StoppedTimeInDays": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of days that an agent has been blocked from completing a milestone. For example, an agent may be waiting for a customer to reply with more information. Note: To display this field, select Enable stopped time and actual elapsed time on the Entitlement Settings page and add the field to the object milestone page layout."
    },
    "StoppedTimeInHrs": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of hours that an agent has been blocked from completing a milestone. For example, an agent may be waiting for a customer to reply with more information. Note: To display this field, select Enable stopped time and actual elapsed time on the Entitlement Settings page and add the field to the object milestone page layout."
    },
    "StoppedTimeInMins": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of minutes that an agent has been blocked from completing a milestone. For example, an agent may be waiting for a customer to reply with more information. Note: To display this field, select Enable stopped time and actual elapsed time on the Entitlement Settings page and add the field to the object milestone page layout."
    },
    "TargetDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time to complete the milestone."
    },
    "TargetResponseInDays": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of days to complete the milestone. Automatically calculated to include the business hours on the record."
    },
    "TargetResponseInHrs": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The number of hours to complete the milestone. Automatically calculated to include the business hours on the record."
    },
    "TargetResponseInMins": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of minutes to complete the milestone. Automatically calculated to include the business hours on the record."
    },
    "TimeRemainingInDays": {
      "type": "string",
      "properties": "Filter, Nillable, Sort",
      "description": "The days that remain before a milestone violation. Automatically calculated to include the business hours on the record."
    },
    "TimeRemainingInHrs": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The hours that remain before a milestone violation. Automatically calculated to include the business hours on the record."
    },
    "TimeRemainingInMins": {
      "type": "string",
      "properties": "Group, Nillable, Sort",
      "description": "The minutes that remain before a milestone violation. Automatically calculated to include the business hours on the record."
    },
    "TimeSinceTargetInDays": {
      "type": "string",
      "properties": "Filter, Nillable, Sort",
      "description": "The days that have elapsed since a milestone violation. Automatically calculated to include the business hours on the record."
    },
    "TimeSinceTargetInHrs": {
      "type": "string",
      "properties": "Filter, Nillable, Sort",
      "description": "The hours that have elapsed since a milestone violation. Automatically calculated to include the business hours on the record."
    },
    "TimeSinceTargetInMins": {
      "type": "string",
      "properties": "Group, Nillable, Sort",
      "description": "The minutes that have elapsed since a milestone violation. Automatically calculated to include the business hours on the record."
    }
  },
  "usage": "When you create an entitlement process, you select its type based on the type of record that you want the process to run on: Case or Work Order. Processes created before Summer ’16 use the Case type. When a Work Order entitlement process runs on a work order, the resulting milestones on the work order are object milestones. Conversely, when a Case entitlement process runs on a case, the resulting milestones are case milestones, a separate standard object.\n\nIf an entitlement has an entitlement process associated with it,\n\t\t\t\t\tdon’t use the entitlement for multiple types of support records. An entitlement\n\t\t\t\t\tprocess works only on records that match the process’s type. For example, when a\n\t\t\t\t\tCase entitlement process is applied to an entitlement, the process runs only on\n\t\t\t\t\tcases associated with that entitlement. If a work order is also associated with\n\t\t\t\t\tthe entitlement, the process doesn’t run on the work order. To ensure that the\n\t\t\t\t\tmilestones you set up work as expected, associate a customer’s work orders and\n\t\t\t\t\tcases with different entitlements.\n\nCustomize page layouts, validation\n\t\t\t\trules, and more for object milestones from the Object Milestones node in Setup under\n\t\t\t\tEntitlement Management.",
  "associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **EntityMilestoneFeed**: Feed tracking is available for the object.\n- **EntityMilestoneHistory**: History is available for tracked fields of the object.",
  "wsdl_segment": "```xml\n<complexType name=\"EntityMilestone\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActualElapsedTimeInDays\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ActualElapsedTimeInHrs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ActualElapsedTimeInMins\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\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=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"BusinessHours\" nillable=\"true\" minOccurs=\"0\" type=\"ens:BusinessHours\"/>\n        <element name=\"BusinessHoursId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"CompletionDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ContentDocumentLinks\" 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=\"ElapsedTimeInDays\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ElapsedTimeInHrs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"ElapsedTimeInMins\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"IsCompleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsViolated\" 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=\"MilestoneType\" nillable=\"true\" minOccurs=\"0\" type=\"ens:MilestoneType\"/>\n        <element name=\"MilestoneTypeId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ParentEntity\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n        <element name=\"ParentEntityId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SlaProcess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:SlaProcess\"/>\n        <element name=\"SlaProcessId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"StartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"StoppedTimeInDays\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"StoppedTimeInHrs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"StoppedTimeInMins\"
  "field_reference": {
    "ActualElapsedTimeInDays": {
      "field_label": "Actual Elapsed Time (Days)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "ActualElapsedTimeInHrs": {
      "field_label": "Actual Elapsed Time (Hours)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "ActualElapsedTimeInMins": {
      "field_label": "Actual Elapsed Time (Mins)",
      "type": "int",
      "digits": "9"
    },
    "BusinessHoursId": {
      "field_label": "Business Hours ID",
      "type": "reference",
      "length": "18"
    },
    "CompletionDate": {
      "field_label": "Completion Date",
      "type": "datetime"
    },
    "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"
    },
    "ElapsedTimeInDays": {
      "field_label": "Elapsed Time (Days)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "ElapsedTimeInHrs": {
      "field_label": "Elapsed Time (Hours)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "ElapsedTimeInMins": {
      "field_label": "Elapsed Time (Mins)",
      "type": "int",
      "digits": "9"
    },
    "Id": {
      "field_label": "Object Milestone ID",
      "type": "id",
      "length": "18"
    },
    "IsCompleted": {
      "field_label": "Completed",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsViolated": {
      "field_label": "Violation",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "MilestoneTypeId": {
      "field_label": "Milestone ID",
      "type": "reference",
      "length": "18"
    },
    "Name": {
      "field_label": "Object Milestone Name",
      "type": "string",
      "length": "255"
    },
    "ParentEntityId": {
      "field_label": "ID",
      "type": "reference",
      "length": "18"
    },
    "SlaProcessId": {
      "field_label": "Entitlement Process ID",
      "type": "reference",
      "length": "18"
    },
    "StartDate": {
      "field_label": "Start Date",
      "type": "datetime"
    },
    "StoppedTimeInDays": {
      "field_label": "Stopped Time (Days)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "StoppedTimeInHrs": {
      "field_label": "Stopped Time (Hours)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "StoppedTimeInMins": {
      "field_label": "Stopped Time (Mins)",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TargetDate": {
      "field_label": "Target Date",
      "type": "datetime"
    },
    "TargetResponseInDays": {
      "field_label": "Target Response (Days)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "TargetResponseInHrs": {
      "field_label": "Target Response (Hours)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "TargetResponseInMins": {
      "field_label": "Target Response (Mins)",
      "type": "int",
      "digits": "9"
    },
    "TimeRemainingInDays": {
      "field_label": "Time Remaining (Days)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "TimeRemainingInHrs": {
      "field_label": "Time Remaining (Hour:Min)",
      "type": "string",
      "length": "10"
    },
    "TimeRemainingInMins": {
      "field_label": "Time Remaining (Min:Sec)",
      "type": "string",
      "length": "10"
    },
    "TimeSinceTargetInDays": {
      "field_label": "Time Since Target (Days)",
      "type": "double",
      "precision": "6",
      "scale": "2"
    },
    "TimeSinceTargetInHrs": {
      "field_label": "Time Since Target (Hour:Min)",
      "type": "string",
      "length": "10"
    },
    "TimeSinceTargetInMins": {
      "field_label": "Time Since Target (Min:Sec)",
      "type": "string",
      "length": "10"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "digits",
    "length"
  ]
}