Get Field Service Object Field

Retrieves the value of an object’s field according to the value of another field. Relevant for Field Service objects only. For example, returns the ID of a Scheduling Policy according to a specific policy’s name.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

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

Inputs

Input	Details
objectName	Type string Description Required. The developer name of the Field Service object. For example, SchedulingPolicy.
fieldName	Type string Description Required. The name of the object’s field used to find the relevant object. For example Name.
fieldValue	Type string Description Required. The value of the specific field used to find the relevant object. For example, Customer First.
fieldToReturn	Type string Description Required. The name of the field whose value you want to return. For example, Id.
isCustomObject	Type boolean Description Required. Indicates whether the object is a custom object (`true`) or a standard object (`false`).

Outputs

Output	Details
fieldServiceStandardVariable	Type string Description Returns the value of an object’s field as an Apex object, which contains a `textValue`, `integerValue`, or `booleanValue`.

Example

Sample request body:

1{
2  "inputs" : [{
3    "objectName" : "SchedulingPolicy",
4    "fieldName" : "Name",
5    "fieldValue" : "Customer First",
6    "fieldToReturn" : "Id",
7    "isCustomObject" : false
8  }]
9}

Sample response body:

1{
2  "actionName" : "getFieldServiceObjectProperty",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6    "fieldServiceStandardVariable" : {
7      "textValue" : "0Vr000000000001AAA",
8      "integerValue" : null,
9      "booleanValue" : null
10    }
11  }
12}

Field Service Developer Guide

Get Field Service Object Field

Supported REST HTTP Methods

Inputs

Outputs

Example