mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
180 lines
9.9 KiB
JSON
180 lines
9.9 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"special_access_rules",
|
||
"associated_objects",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "ServiceReport - Data API",
|
||
"description": "Represents a report that summarizes a work order, work order line item, or service appointment.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description"
|
||
],
|
||
"fields": {
|
||
"ContentVersionDocumentId": {
|
||
"type": "reference",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "ID of the service report version, used for storage."
|
||
},
|
||
"DocumentBody": {
|
||
"type": "base64",
|
||
"properties": "Create, Nillable",
|
||
"description": "The report output. DocumentBody can’t be retrieved via REST API."
|
||
},
|
||
"DocumentContentType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
|
||
"description": "The type of data used for the report output.. Possible values are: audio/ogg text/calendar video/3gpp2 video/3gpp image/avif text/calendar audio/x-caf image/webp"
|
||
},
|
||
"DocumentLength": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The length of the report output."
|
||
},
|
||
"DocumentName": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort",
|
||
"description": "The name of the report output, always set to Service Report."
|
||
},
|
||
"DocumentTemplate": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort",
|
||
"description": "The template used to generate service documents for the Document Builder feature. Important: DocumentTemplate is different from Template. The document template needs to reference a flexipage that is of type serviceDocument and must target the object used to generate the service document. For example, you can't use an Account flexipage for a service report tied to a work order."
|
||
},
|
||
"IsSigned": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort",
|
||
"description": "Indicates whether the service report contains one or more signatures. This field isn’t supported for Document Builder. Tip: Add this field to the Service Reports related list on work orders, work order line items, and service appointments."
|
||
},
|
||
"ParentId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "The ID of the service appointment, work order, or work order line item that the service report summarizes. For example, if you click Create Service Report on a service appointment, this field lists the service appointment’s record ID."
|
||
},
|
||
"ServiceReportLanguage": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Restricted picklist",
|
||
"description": "The language used for the service report. The language is selected in the ServiceReportLanguage field on the associated work order. If the work order doesn’t specify a service report language, the report is translated in the default language in Salesforce of the person generating the report."
|
||
},
|
||
"ServiceReportNumber": {
|
||
"type": "string",
|
||
"properties": "Autonumber, Defaulted on create, Filter, Sort",
|
||
"description": "An auto-generated number identifying the service report."
|
||
},
|
||
"Status": {
|
||
"type": "picklist",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "The status of the service report. Available in API version 53.0 and later. Possible values are: Completed Failed Generating In Progress None Queued The default value is None."
|
||
},
|
||
"Template": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort",
|
||
"description": "The service report template used to generate the service report. Note: If the person creating the service report doesn’t have access to certain objects or fields that are included in the service report template, those fields aren’t visible in the report they create."
|
||
}
|
||
},
|
||
"special_access_rules": "Field Service must be enabled.",
|
||
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **ServiceReportChangeEvent**: Change events are available for the object. Available in API version 55.0 and later.\n- **ServiceReportHistory**: 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<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=\"ServiceReport\">\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=\"ContentVersionDocument\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContentVersion\"/>\n <element name=\"ContentVersionDocumentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"DocumentBody\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n <element name=\"DocumentContentType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DocumentLength\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"DocumentName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"IsSigned\" 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=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"ParentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ServiceReportLanguage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ServiceReportNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Template\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"ContentVersionDocumentId": {
|
||
"field_label": "Content Version 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"
|
||
},
|
||
"DocumentBody": {
|
||
"field_label": "Document Body",
|
||
"type": "base64"
|
||
},
|
||
"DocumentContentType": {
|
||
"field_label": "Document Content Type",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"DocumentLength": {
|
||
"field_label": "Document Length",
|
||
"type": "int",
|
||
"digits": "9"
|
||
},
|
||
"DocumentName": {
|
||
"field_label": "Document Name",
|
||
"type": "string",
|
||
"length": "40"
|
||
},
|
||
"Id": {
|
||
"field_label": "Service Report ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"IsSigned": {
|
||
"field_label": "Signed",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"ParentId": {
|
||
"field_label": "Parent ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"ServiceReportLanguage": {
|
||
"field_label": "Service Report Language",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"ServiceReportNumber": {
|
||
"field_label": "Service Report Name",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"Status": {
|
||
"field_label": "Status",
|
||
"type": "picklist",
|
||
"length": "255"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
},
|
||
"Template": {
|
||
"field_label": "Service Report Template",
|
||
"type": "string",
|
||
"length": "255"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"length",
|
||
"digits"
|
||
]
|
||
} |