EmbeddedServiceFieldService

Represents a setup node for creating an embedded Appointment Management (beta) deployment. Available in Tooling API version 43.0 and later.

Supported Calls

create(), delete() describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

GET, POST, PATCH, DELETE

Fields

Field	Details
AppointmentBookingFlowName	Type string Properties Filter, Group, Nillable, Sort Description Name of the appointment booking flow for this Embedded Service deployment.
CancelApptBookingFlowName	Type string Properties Filter, Group, Nillable, Sort Description Name of the appointment cancellation flow for this embedded Appointment Management (beta) deployment.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description Unique name for the embedded Appointment Management configuration setup node. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
EmbeddedServiceConfigId	Type EmbeddedServiceConfig Properties Create, Filter, Group, Sort, Update Description Unique ID for the embedded Appointment Management (beta) deployment.
Enabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether Field Service is enabled for this Embedded Service deployment (`true`) or not (`false`).
FieldServiceConfirmCardImg	Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the confirmation card in embedded Appointment Management (beta).
FieldServiceHomeImg	Type string Properties Filter, Group, Nillable, Sort Description URL of the image used for the home screen in embedded Appointment Management (beta).
FieldServiceLogoImg	Type string Properties Filter, Group, Nillable, Sort Description URL of the logo used for the home screen in embedded Appointment Management (beta).
FullName	Type string Properties Create, Group, Nillable Description The unique name used for this Embedded Service deployment. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Languages supported in the Embedded Service deployment. Chinese (Simplified): `zh_CN` Chinese (Traditional): `zh_TW` Danish: `da` Dutch: `nl_NL` English: `en_US` Finnish: `fi` French: `fr` German: `de` Italian: `it` Japanese: `ja` Korean: `ko` Norwegian: `no` Portuguese (Brazil): `pt_BR` Russian: `ru` Spanish: `es` Spanish (Mexico): `es_MX` Spanish (Mexico) defaults to Spanish for customer-defined translations. Swedish: `sv` Thai: `th` The Salesforce user interface is fully translated to Thai, but Help is in English.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description Name of the Embedded Service deployment.
Metadata	Type `mns:`EmbeddedServiceFieldService Properties Create, Nillable, Update Description The embedded Appointment Management (beta) metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
ModifyApptBookingFlowName	Type string Properties Filter, Group, Nillable, Sort Description Name of the appointment modification flow for this embedded Appointment Management (beta) deployment.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
ShouldShowExistingAppointment	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether to display a button on the home screen for customers to access their existing appointments (true) or not (false) for embedded Appointment Management (beta).
ShouldShowNewAppointment	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether to display a button on the home screen for customers to create a new appointment (true) or not (false) for embedded Appointment Management (beta).