Field Service Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Field Service Developer Guide
Get Ready to Develop with Field Service
API End-of-Life Policy
Field Service Data Objects
Field Service REST API
Field Service Metadata API
Field Service Tooling API
Field Service Apex Namespace
Field Service Custom Triggers
Field Service Code Examples
Create a Service Report with Apex
Generate Work Orders on Maintenance Plans with Apex
Code Examples: Dispatcher Console Custom Actions
Field Service Mobile App
PDF

Create a Service Report with Apex

The Create Service Report action on work orders, work order line items, and service appointments can also be called using Apex code. The code example shown creates a service report with two signatures by making an Apex callout to the createServiceReport action REST API resource.
Each service report contains data from its parent record and signatures from customers, technicians, or others who must sign off on the work. In your API call, you can define one or more signatures to be used in the report. The number and type of signatures must match the service report template's signature settings.
  • This code example applies to API version 41.0 and later. Service reports generated with API version 40.0 can contain only one signature.
  • This code example assumes that you have remote site settings enabled to make REST callouts. For more information, see Adding Remote Site Settings.
  • The mock record ID in the code example is 0WOxx000000001E. The mock service report template ID is 0SLR00000004DBFOA2.

Note

API Endpoint (v41.0): /services/data/v41.0/actions/standard/createServiceReport

String salesforceHost = System.Url.getSalesforceBaseURL().toExternalForm();
String url = salesforceHost + '/services/data/v41.0/actions/standard/createServiceReport';
// Create HTTP request
HttpRequest request = new HttpRequest();
request.setEndpoint(url);
request.setMethod('POST');
request.setHeader('Content-Type', 'application/json');
request.setHeader('Authorization', 'OAuth ' + UserInfo.getSessionId());
// Set the body as a JSON object
request.setBody('{"inputs" : [ {"entityId" : "0WOxx000000001E","signatures" : [{"data":"Base64 code for the captured signature image","contentType":"image/png","name":"Customer Signature","signatureType":"Default","place":"San Francisco","signedBy":"John Doe","signedDate":"2019-06-05 12:00:00"}],"templateId" : "0SLR00000004DBFOA2"} ]}');
Http http = new Http();
HttpResponse response = http.send(request);
// Parse the JSON response
if (response.getStatusCode() != 201) {
    System.debug('The status code returned was not expected: ' +
                 response.getStatusCode() + ' ' + response.getStatus());
} else {
    System.debug(response.getBody());
}

This code example creates a payload with two signatures.

{
   "inputs":[
      {
         "entityId":"0WOxx000000001E",
         "signatures":[
            {
               "data":"Base64 code for the captured signature image",
               "contentType":"image/png",
               "name":"Customer Signature",
               "signatureType":"Customer",
               "place":"San Francisco",
               "signedBy":"John Doe",
               "signedDate":"Thu Jul 13 22:34:43 GMT 2017"
            },
            {
               "data":"Base64 code for the captured signature image",
               "contentType":"image/png",
               "name":"Technician Signature",
               "signatureType":"Technician"
            }
         ],
         "templateId":"0SLR00000004DBFOA2"
      }
   ]
}

Field Descriptions

  • entityId: The ID of the work order, work order line item, or service report that you want to create the service report for.
  • signatures: A list of JSON definitions for a digital signature.
    • data: (Required) The base64 code for an image.
    • contentType: (Required)The file type of the signature.
    • signatureType: (Required) The role of the person signing such as Customer. Signature Type picklist values are defined by the Salesforce admin ahead of time. Each signature block must use a different signature type, and the signature types that you define in your call must match the service report template’s signature types.
    • name: The signature block title. This value appears on the generated service report.
    • place: The place of signing. This value appears on the generated service report.
    • signedBy: The name of the person signing. This value appears on the generated service report.
    • signedDate: The date of signing. This value appears on the generated service report.
  • templateId: The ID of the service report template used for the report. To find the ID, run a SOQL query on the ServiceReportLayout object.

Limitations

If you’re a guest user and are using Future annotation, the ContentDocument object can’t be created and you can’t create the Service Document.