afv-library/skills/platform-metadata-api-context-get/data/metadata_api/EmbeddedServiceFieldService.json

73 lines
3.8 KiB
JSON

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"declarative_metadata_sample_definition"
],
"title": "EmbeddedServiceFieldService - Metadata API",
"description": "Represents a setup node for creating an embedded Appointment Management deployment. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": ".EmbeddedServiceFieldService",
"directory_location": "EmbeddedServiceFieldService",
"fields_columns": [
"type",
"description"
],
"fields": {
"appointmentBookingFlowName": {
"type": "string",
"description": "Name of the appointment booking flow for this embedded Appointment Management (beta) deployment."
},
"cancelApptBookingFlowName": {
"type": "string",
"description": "Name of the appointment cancellation flow for this embedded Appointment Management (beta) deployment."
},
"embeddedServiceConfig": {
"type": "string",
"description": "The name of the Embedded Service configuration node.",
"required": true
},
"enabled": {
"type": "boolean",
"description": "Indicates whether this embedded Appointment Management deployment is enabled (true).",
"required": true
},
"fieldServiceConfirmCardImg": {
"type": "string",
"description": "URL of the image used for the confirmation card in embedded Appointment Management (beta)."
},
"fieldServiceHomeImg": {
"type": "string",
"description": "URL of the image used for the home screen in embedded Appointment Management (beta)."
},
"fieldServiceLogoImg": {
"type": "string",
"description": "URL of the logo used for the home screen in embedded Appointment Management (beta)."
},
"masterLabel": {
"type": "string",
"description": "Name of the embedded Appointment Management (beta) deployment.",
"required": true
},
"modifyApptBookingFlowName": {
"type": "string",
"description": "Name of the appointment modification flow for this embedded Appointment Management (beta) deployment."
},
"shouldShowExistingAppointment": {
"type": "boolean",
"description": "Specifies whether to display a button on the home screen for customers to access their existing appointments (true) or not (false). This field is false by default."
},
"shouldShowNewAppointment": {
"type": "boolean",
"description": "Specifies whether to display a button on the home screen for customers to create a new appointment (true) or not (false). This field is false by default."
}
},
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of an EmbeddedServiceFieldService file.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<EmbeddedServiceFieldService xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <appointmentBookingFlowName>ESW_FS_BookAppt_Main_Flow</appointmentBookingFlowName>\n <cancelApptBookingFlowName>ESW_FS_CancelAppt_Flow</cancelApptBookingFlowName>\n <embeddedServiceConfig>EswFS</embeddedServiceConfig>\n <enabled>true</enabled>\n <fieldServiceConfirmCardImg>https://google.com/AppointmentConfirmationImg.png</fieldServiceConfirmCardImg>\n <fieldServiceHomeImg>https://google.com/HeroImg.png</fieldServiceHomeImg>\n <fieldServiceLogoImg>https://google.com/logo.png</fieldServiceLogoImg>\n <masterLabel>EmbeddedServiceFieldService_Parent04IRM000000007p2AA_162d4270834</masterLabel>\n <modifyApptBookingFlowName>ESW_FS_ModifyAppt_Main_Flow</modifyApptBookingFlowName>\n <shouldShowExistingAppointment>true</shouldShowExistingAppointment>\n <shouldShowNewAppointment>true</shouldShowNewAppointment>\n</EmbeddedServiceFieldService>"
}
]
}