Create Service Report Actions

Creates a service report for a service appointment, work order, or work order line item.

This object is available in API version 39.0 and later.

The Create Service Report action can't be triggered from a flow. To automatically launch the report preview and signature interface in the Salesforce Field Service Mobile app, create an app extension named Service_Report_Flow. For more information, see Build Flows for the Field Service Mobile App.

Note

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/createServiceReport

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
entityId reference Required. The ID of the service appointment, work order, or work order line item that the service report is created for.
signatures string Optional. A list of JSON definitions for a digital signature. Each object includes: data (Required, base64-encoded signature image), contentType (Required, file type of the signature), signatureType (Required, role of the signer such as "Customer"), and optionally name (block title), place (place of signing), signedBy (signer name), and signedDate (date of signing). Each signature block must use a unique signature type matching the service report template's signature types.
templateId reference Required. The ID of the standard or custom service report template that is used to create the service report.

Usage

Sample Input

The following code sample creates a service report with two signatures by making an Apex callout to the createServiceReport action REST API resource.

1{
2       "inputs" : [ {
3          "entityId" : "0WOxx000000001E",
4             "signatures" : [
5                      {"data":"Base64 code for the captured signature image",
6                      "contentType":"image/png",
7                      "name":"Customer Signature",
8                      "signatureType":"Customer",
9                      "place":"San Francisco",
10                      "signedBy":"John Doe",
11                      "signedDate":"Thu Jul 13 22:34:43 GMT 2017"               
12                      },
13                      {"data":"Base64 code for the captured signature image",
14                      "contentType":"image/png",
15                      "name":"Technician Signature",
16                      "signatureType":"Technician"
17                      }],
18             "templateId" : "0SLR00000004DBFOA2"
19       } ]
20    }