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

340 lines
20 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "ProductRequest - Data API",
"description": "Represents an order for a part or parts in field service.",
"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. This is a relationship field.",
"relationship_name": "Account",
"relationship_type": "Lookup",
"refers_to": "Account"
},
"CaseId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The case associated with the product request. This is a relationship field.",
"relationship_name": "Case",
"relationship_type": "Lookup",
"refers_to": "Case"
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code."
},
"Description": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "A text field for 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 date when the product request 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 request was last viewed."
},
"NeedByDate": {
"type": "dateTime",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "Date the product must be delivered by."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The owner of the shipment. This is a polymorphic relationship field.",
"relationship_name": "Owner",
"relationship_type": "Lookup",
"refers_to": "Group, User"
},
"ProductRequestNumber": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "An auto-assigned number that identifies the shipment."
},
"ShipToAddress": {
"type": "address",
"properties": "Filter, Nillable",
"description": "The address that the product is to be delivered to."
},
"ShipToCity": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The city that the product is to be delivered to."
},
"ShipToCountry": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The country that the product is to be delivered to."
},
"ShipToCountryCode": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A two letter uppercase country code conforming to the ISO 3166-1 alpha-2 standard."
},
"ShipToGeocodeAccuracy": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The accuracy of the geocode for the shipping address."
},
"ShipToLatitude": {
"type": "double",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The latitude of the location where the product is to be delivered to."
},
"ShipToLongitude": {
"type": "double",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The longitude of the location where the product is to be delivered to."
},
"ShipToPostalCode": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The postal code of the address where the product is to be delivered to."
},
"ShipToState": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The name of the state where the product is to be delivered to."
},
"ShipToStateCode": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A two letter uppercase state code conforming to the ISO 3166-1 alpha-2 standard."
},
"ShipToStreet": {
"type": "textarea",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The street address where the product is to be delivered to."
},
"ShipmentType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "The type of shipment. The picklist includes the following values by default: None Rush Overnight Next Business Day Pick Up"
},
"SourceLocationId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The location the product is shipped from. 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": "Status of the product transfer."
},
"WorkOrderId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The work order that the product request is related to. 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 that the product request is related to. This is a relationship field.",
"relationship_name": "WorkOrderLineItem",
"relationship_type": "Lookup",
"refers_to": "WorkOrderLineItem"
}
},
"special_access_rules": "Field Service must be enabled. Authenticated external users can create and update ProductRequest objects.\n\nField Service must be enabled.\n\nAuthenticated external users can create and update ProductRequest objects.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **ProductRequestChangeEvent (API version 48.0)**: Change events are available for the object.\n- **ProductRequestFeed**: Feed tracking is available for the object.\n- **ProductRequestHistory**: History is available for tracked fields of the object.\n- **ProductRequestOwnerSharingRule**: Sharing rules are available for the object.\n- **ProductRequestShare**: 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<complexType name=\"ProductRequest\">\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=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" 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
"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 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"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ProductRequestNumber": {
"field_label": "Product Request Number",
"type": "string",
"length": "255"
},
"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"
]
}