{
"sections": [
"title",
"description",
"supported_soap_calls",
"supported_rest_api_http_methods",
"fields",
"special_access_rules",
"wsdl_segment"
],
"title": "EmbeddedServiceFlow - Tooling API",
"description": "Represents a Flow Definition used by an Embedded Service deployment. This object is available in API version 45.0 and later.",
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"EmbeddedServiceConfigId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The unique ID of EmbeddedServiceConfig (the Embedded Service deployment)."
},
"Feature": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The Embedded Service feature that uses this flow. This is a read-only field. Possible values are: FieldService Flows LiveAgent"
},
"Flow": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The flow definition name. Use one of the listed standard flows or an ID of a FlowDefinition that you created. Possible standard flow values are: runtime_sales_see__SEE setup_service_experience__Create_Case setup_service_experience__Verify_Cust"
},
"FlowType": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The flow type used in a Flow (FL), Appointment Booking (FS), or Chat (LA) feature of Embedded Service. Possible values are: FL_Flow FS_CancelAppointment FS_ModifyAppointment FS_NewAppointment LA_Survey"
},
"IsAuthenticationRequired": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Specifies whether authentication is required for this flow (true) or not (false). Authentication is required if the FlowType is an Appointment Booking type. Default is false."
}
},
"special_access_rules": "To access this type, you need the Customize Application user permission.",
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n```"
}