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

194 lines
12 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "WorkPlan - Data API",
"description": "Represents a work plan for a work order or work order line item. This object is available in API version 52.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "The description of the work plan."
},
"ExecutionOrder": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The order in which the work plan is executed. Only positive values or null are supported."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last interacted with this record, directly or indirectly."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the work plan."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the user who created the work plan.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"ParentRecordId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID of the work order, work order line item, or change request that the work plan is associated with. Available in API version 54.0 and later. This field is a polymorphic relationship field.",
"relationship_name": "ParentRecord",
"relationship_type": "Lookup",
"refers_to": "ChangeRequest, WorkOrder, WorkOrderLineItem"
},
"ParentRecordType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Describes whether the parent record is a work order, work order line item, or change request. Available in API version 54.0 and later."
},
"WorkOrderId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the work order.",
"relationship_name": "WorkOrder",
"relationship_type": "Lookup",
"refers_to": "WorkOrder",
"required": true
},
"WorkOrderLineItemId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the work order line item.",
"relationship_name": "WorkOrderLineItem",
"relationship_type": "Lookup",
"refers_to": "WorkOrderLineItem"
},
"WorkPlanTemplateId": {
"type": "reference",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the work plan template record. Available in API version 54.0 and later. This field is a relationship field.",
"relationship_name": "WorkPlanTemplate",
"relationship_type": "Lookup",
"refers_to": "WorkPlanTemplate"
}
},
"special_access_rules": "Field Service must be enabled.",
"associated_objects": "This object has these associated objects. Unless noted, theyre available in the same API version as this object.\n\n- **WorkPlanChangeEvent**: Change events are available for the object. Available in API version 54.0 and later.\n- **WorkPlanFeed**: Feed tracking is available for the object.\n- **WorkPlanHistory**: History is available for tracked fields of the object.\n- **WorkPlanOwnerSharingRule**: Sharing rules are available for the object.\n- **WorkPlanShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\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<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n<complexType name=\"WorkPlan\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"Attachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ExecutionOrder\" 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=\"IsDeleted\" 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=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"NotesAndAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ParentRecord\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"ParentRecordId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ParentRecord
"field_reference": {
"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"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "32000"
},
"ExecutionOrder": {
"field_label": "Execution Order",
"type": "int",
"digits": "9"
},
"Id": {
"field_label": "Work Plan ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ParentRecordId": {
"field_label": "Parent Record ID",
"type": "reference",
"length": "18"
},
"ParentRecordType": {
"field_label": "Parent Record Type",
"type": "string",
"length": "50"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"WorkOrderId": {
"field_label": "Work Order ID",
"type": "reference",
"length": "18"
},
"WorkOrderLineItemId": {
"field_label": "Work Order Line Item ID",
"type": "reference",
"length": "18"
},
"WorkPlanTemplateId": {
"field_label": "Work Plan Template ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}