mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
168 lines
11 KiB
JSON
168 lines
11 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"usage",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "ProductRequired - Data API",
|
||
"description": "Represents a product that is needed to complete a work order or work order line item in field service.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description",
|
||
"relationship_name",
|
||
"relationship_type",
|
||
"refers_to"
|
||
],
|
||
"fields": {
|
||
"LastReferencedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The date when the product required was last modified. Its label in the user interface is Last Modified Date."
|
||
},
|
||
"LastViewedDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Nillable, Sort",
|
||
"description": "The date when the product required was last viewed."
|
||
},
|
||
"ParentRecordId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "The work order or work order line item that the product is required for. This is a polymorphic relationship field.",
|
||
"relationship_name": "ParentRecord",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Visit, WorkOrder, WorkOrderLineItem, WorkType"
|
||
},
|
||
"ParentRecordType": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "Indicates whether the parent record is a work order or a work order line item."
|
||
},
|
||
"Product2Id": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "The required product. This is a relationship field.",
|
||
"relationship_name": "Product2",
|
||
"relationship_type": "Lookup",
|
||
"refers_to": "Product2"
|
||
},
|
||
"ProductName": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The name of the product required."
|
||
},
|
||
"ProductRequiredNumber": {
|
||
"type": "string",
|
||
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
|
||
"description": "(Read only) Auto-generated number identifying the product required."
|
||
},
|
||
"QuantityRequired": {
|
||
"type": "double",
|
||
"properties": "Create, Filter, Nillable, Sort, Update",
|
||
"description": "Quantity required of the product."
|
||
},
|
||
"QuantityUnitOfMeasure": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Units of the required product; for example, kilograms or liters. Quantity Unit of Measure picklist values are inherited from the Quantity Unit of Measure field on products."
|
||
}
|
||
},
|
||
"special_access_rules": "Field Service must be enabled.",
|
||
"usage": "Required products can be added to work types, work orders, and work order line items to ensure that the assigned service resource arrives with the right equipment. Adding required products to work types saves you time and keeps your business processes consistent. Work orders and work order line items inherit their work type’s required products. For example, if all light bulb replacement jobs require a ladder and a light bulb, add the ladder and light bulb as required products to your Light Bulb Replacement work type. When it’s time to create a work order for a customer’s light bulb replacement, applying that work type to the work order adds the required products.\n\nRequired products can be added to work types, work orders, and work order line items to ensure that the assigned service resource arrives with the right equipment.\n\nAdding required products to work types saves you time and keeps your business processes consistent. Work orders and work order line items inherit their work type’s required products. For example, if all light bulb replacement jobs require a ladder and a light bulb, add the ladder and light bulb as required products to your Light Bulb Replacement work type. When it’s time to create a work order for a customer’s light bulb replacement, applying that work type to the work order adds the required products.",
|
||
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **ProductRequiredChangeEvent**: Change events are available for the object.\n- **ProductRequiredFeed**: Feed tracking is available for the object.\n- **ProductRequiredHistory**: History is available for tracked fields of 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<complexType name=\"ProductRequired\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\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=\"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=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"NotesAndAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"ParentRecordType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"Product2\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Product2\"/>\n <element name=\"Product2Id\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ProductName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ProductRequiredNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"QuantityRequired\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"QuantityUnitOfMeasure\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"TopicAssignments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\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```",
|
||
"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"
|
||
},
|
||
"Id": {
|
||
"field_label": "Product Required 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"
|
||
},
|
||
"ParentRecordId": {
|
||
"field_label": "Parent Record ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"ParentRecordType": {
|
||
"field_label": "Parent Record Type",
|
||
"type": "string",
|
||
"length": "50"
|
||
},
|
||
"Product2Id": {
|
||
"field_label": "Product ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"ProductName": {
|
||
"field_label": "Product Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"ProductRequiredNumber": {
|
||
"field_label": "Product Required Number",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"QuantityRequired": {
|
||
"field_label": "Quantity Required",
|
||
"type": "double",
|
||
"precision": "18",
|
||
"scale": "2"
|
||
},
|
||
"QuantityUnitOfMeasure": {
|
||
"field_label": "Quantity Unit Of Measure",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"precision",
|
||
"scale"
|
||
]
|
||
} |