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

297 lines
12 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "CaseMilestone - Data API",
"description": "Represents a milestone (required step in a customer support process) on a Case. This object is available in API version 18.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"BusinessHoursId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "ID of the BusinessHours associated with the CaseMilestone."
},
"CaseId": {
"type": "reference",
"properties": "Filter",
"description": "ID of the case."
},
"CompletionDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Update",
"description": "The date and time the milestone was completed."
},
"ElapsedTimeInDays": {
"type": "double",
"properties": "Filter, Nillable",
"description": "The time required to complete a milestone in days."
},
"ElapsedTimeInHrs": {
"type": "double",
"properties": "Filter, Nillable",
"description": "The time required to complete a milestone in hours."
},
"ElapsedTimeInMins": {
"type": "int",
"properties": "Filter, Nillable",
"description": "The time required to complete a milestone in minutes."
},
"IsCompleted": {
"type": "boolean",
"properties": "Defaulted on create, Filter",
"description": "Indicates whether the milestone is completed (true) or not (false)."
},
"IsViolated": {
"type": "boolean",
"properties": "Defaulted on create, Filter",
"description": "Indicates whether the milestone is violated (true) or not (false)."
},
"MilestoneTypeId": {
"type": "reference",
"properties": "Filter, Nillable",
"description": "The ID of the milestone on the case."
},
"StartDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Update",
"description": "The date and time the milestone started on the case."
},
"TargetDate": {
"type": "dateTime",
"properties": "Filter",
"description": "The date and time the milestone must be completed."
},
"TargetResponseInDays": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The time to complete the milestone in days."
},
"TargetResponseInHrs": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "The time to complete the milestone in hours."
},
"TargetResponseInMins": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The time to complete the milestone in minutes."
},
"TimeRemainingInDays": {
"type": "double",
"properties": "Group, Nillable, Sort",
"description": "Time remaining to reach the milestone target, measured in days."
},
"TimeRemainingInHrs": {
"type": "text",
"properties": "Nillable",
"description": "Time remaining to reach the milestone target, measured in hours."
},
"TimeRemainingInMins": {
"type": "text",
"properties": "Group, Nillable, Sort",
"description": "Time remaining to reach the milestone target. The format is minutes and seconds."
},
"TimeSinceTargetInDays": {
"type": "double",
"properties": "Nillable, Sort",
"description": "The time elapsed since the milestone target, measured in days."
},
"TimeSinceTargetInHrs": {
"type": "string",
"properties": "Group, Nillable, Sort",
"description": "The time elapsed since the milestone target, measured in hours."
},
"TimeSinceTargetInMins": {
"type": "string",
"properties": "Group, Nillable, Sort",
"description": "The time elapsed since the milestone target. The format is minutes and seconds."
}
},
"usage": "This object lets you view a milestone on a case. It also lets you view if the milestone was completed and when it must be completed.",
"wsdl_segment": "```xml\n<complexType name=\"CaseMilestone\">\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=\"BusinessHours\" nillable=\"true\" minOccurs=\"0\" type=\"ens:BusinessHours\"/>\n <element name=\"BusinessHoursId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Case\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Case\"/>\n <element name=\"CaseId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CompletionDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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=\"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=\"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\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"TargetDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"TargetResponseInDays\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"TargetResponseInHrs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"TargetResponseInMins\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"TimeRemainingInDays\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"TimeRemainingInHrs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TimeRemainingInMins\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TimeSinceTargetInDays\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"TimeSinceTargetInHrs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TimeSinceTargetInMins\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\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```",
"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"
},
"CaseId": {
"field_label": "Case 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"
},
"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": "Case 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"
},
"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"
]
}