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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ProductRequestLineItem - Data API",
  "description": "Represents a request for a part in field service. Product request line items are components of product requests.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AccountId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The account associated with the product request line item. This is a relationship field.",
      "relationship_name": "Account",
      "relationship_type": "Lookup",
      "refers_to": "Account"
    },
    "CareProgramEnrolleeId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the care program enrollee associated with the product request line item. This field is available from API version 49.0 and later. This is a relationship field.",
      "relationship_name": "CareProgramEnrollee",
      "relationship_type": "Lookup",
      "refers_to": "CareProgramEnrollee"
    },
    "CaseId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The case associated with the product request line item. This is a relationship field.",
      "relationship_name": "Case",
      "relationship_type": "Lookup",
      "refers_to": "Case"
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "Details not recorded in the provided fields."
    },
    "DestinationLocationId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Where the product is delivered. This is a relationship field.",
      "relationship_name": "DestinationLocation",
      "relationship_type": "Lookup",
      "refers_to": "Location"
    },
    "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."
    },
    "NeedByDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Date the product must be delivered by."
    },
    "ParentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The product request that the line item belongs to. This is a relationship field.",
      "relationship_name": "Parent",
      "relationship_type": "Lookup",
      "refers_to": "ProductRequest"
    },
    "Product2Id": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The product associated with the product request line item. This is a relationship field.",
      "relationship_name": "Product2",
      "relationship_type": "Lookup",
      "refers_to": "Product2"
    },
    "ProductRequestLineItemNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "(Read Only) An auto-assigned number that identifies the product request line item."
    },
    "QuantityRequested": {
      "type": "double",
      "properties": "Create, Filter, Sort, Update",
      "description": "The amount requested."
    },
    "QuantityUnitOfMeasure": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Units of the requested product; for example, grams, liters, or units. The picklist values can be customized."
    },
    "ShipToAddress": {
      "type": "address",
      "properties": "Filter, Nillable",
      "description": "The physical address where the product is needed."
    },
    "ShipToCity": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The city of the address where the product is needed."
    },
    "ShipToCountry": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The country of the address where the product is needed."
    },
    "ShipToGeocodeAccuracy": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Accuracy level of the geocode for the address where the product is needed. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only."
    },
    "ShipToLatitude": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Used with Longitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only."
    },
    "ShipToLongitude": {
      "type": "double",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Used with Latitude to specify the precise geolocation of the address where the product is needed. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields. This field is available in the API only."
    },
    "ShipToPostalCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The postal code of the address where the product is needed."
    },
    "ShipToState": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The state of the address where the product is needed."
    },
    "ShipToStreet": {
      "type": "textarea",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The street of the address where the product is needed."
    },
    "ShipmentType": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
      "description": "The type of shipment. The picklist includes the following values, which can be customized: Rush Overnight Next Business Day Pick Up"
    },
    "SourceLocationId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Where the product is at the time of the request. This is a relationship field.",
      "relationship_name": "SourceLocation",
      "relationship_type": "Lookup",
      "refers_to": "Location"
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
      "description": "The status of the shipment. The picklist includes the following values, which can be customized: Draft Submitted Received"
    },
    "WorkOrderId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The work order for which the product is needed. This is a relationship field.",
      "relationship_name": "WorkOrder",
      "relationship_type": "Lookup",
      "refers_to": "WorkOrder"
    },
    "WorkOrderLineItemId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The work order line item for which the product is needed. This is a relationship field.",
      "relationship_name": "WorkOrderLineItem",
      "relationship_type": "Lookup",
      "refers_to": "WorkOrderLineItem"
    }
  },
  "special_access_rules": "Field Service must be enabled. You can't use product request line item as a master in an master detail relationship (through a custom field) with a custom object with data.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **ProductRequestLineItemChangeEvent (API version 48.0)**: Change events are available for the object.\n- **ProductRequestLineItemFeed**: Feed tracking is available for the object.\n- **ProductRequestLineItemHistory**: 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=\"ProductRequestLineItem\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Account\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"AccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"Case\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Case\"/>\n        <element name=\"CaseId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"DestinationLocation\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Location\"/>\n        <element name=\"DestinationLocationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"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=\"NeedByDate\" 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=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ProductRequest\"/>\n        <element name=\"ParentId\" 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:Query
  "field_reference": {
    "AccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "CareProgramEnrolleeId": {
      "field_label": "Care Program Enrollee ID",
      "type": "reference",
      "length": "18"
    },
    "CaseId": {
      "field_label": "Case ID",
      "type": "reference",
      "length": "18"
    },
    "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"
    },
    "DestinationLocationId": {
      "field_label": "Destination Location ID",
      "type": "reference",
      "length": "18"
    },
    "Id": {
      "field_label": "Product Request Line Item 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"
    },
    "NeedByDate": {
      "field_label": "Need By Date",
      "type": "datetime"
    },
    "ParentId": {
      "field_label": "Product Request ID",
      "type": "reference",
      "length": "18"
    },
    "Product2Id": {
      "field_label": "Product ID",
      "type": "reference",
      "length": "18"
    },
    "ProductRequestLineItemNumber": {
      "field_label": "Product Request Line Item Number",
      "type": "string",
      "length": "255"
    },
    "QuantityRequested": {
      "field_label": "Quantity Requested",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "QuantityUnitOfMeasure": {
      "field_label": "Quantity Unit Of Measure",
      "type": "picklist",
      "length": "40"
    },
    "ShipToAddress": {
      "field_label": "Ship To Address",
      "type": "address"
    },
    "ShipToCity": {
      "field_label": "City",
      "type": "string",
      "length": "40"
    },
    "ShipToCountry": {
      "field_label": "Country",
      "type": "string",
      "length": "80"
    },
    "ShipToGeocodeAccuracy": {
      "field_label": "Geocode Accuracy",
      "type": "picklist",
      "length": "40"
    },
    "ShipToLatitude": {
      "field_label": "Latitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "ShipToLongitude": {
      "field_label": "Longitude",
      "type": "double",
      "precision": "18",
      "scale": "15"
    },
    "ShipToPostalCode": {
      "field_label": "Zip/Postal Code",
      "type": "string",
      "length": "20"
    },
    "ShipToState": {
      "field_label": "State/Province",
      "type": "string",
      "length": "80"
    },
    "ShipToStreet": {
      "field_label": "Address",
      "type": "textarea",
      "length": "255"
    },
    "ShipmentType": {
      "field_label": "Shipment Type",
      "type": "picklist",
      "length": "40"
    },
    "SourceLocationId": {
      "field_label": "Source Location ID",
      "type": "reference",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "40"
    },
    "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"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}