Newer Version Available

This content describes an older version of this product. View Latest

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.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/createServiceReport
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
entityId
Type
reference
Description
Required. The ID of the service appointment, work order, or work order line item that the service report is created for.
signatures
Type
string
Description
Optional. 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; for example, “Customer.” Salesforce admin defines Signature Type picklist values ahead of time. Each signature block must use a different signature type, and the signature types 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
Type
reference
Description
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    }