arcade-mcp/toolkits/freshservice_api/arcade_freshservice_api/wrapper_tools/GetBusinessHoursConfig.json

115 lines
3.4 KiB
JSON

{
"name": "GetBusinessHoursConfig",
"fully_qualified_name": "FreshserviceApi.GetBusinessHoursConfig@1.0.0",
"description": "Retrieve the Business Hours configuration from Freshservice.\n\nThis tool retrieves the Business Hours configuration using the provided ID from Freshservice. It should be called when detailed information about specific business hours settings is required.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "1.0.0"
},
"input": {
"parameters": [
{
"name": "business_hours_configuration_id",
"required": true,
"description": "The unique ID of the Business Hours configuration to retrieve from Freshservice.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of Business Hours configuration to retrieve"
},
"inferrable": true,
"http_endpoint_parameter_name": "business_hours_id"
}
]
},
"output": {
"description": "Response from the API endpoint 'get-business-hours-config'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": null,
"secrets": [
{
"key": "FRESHSERVICE_SUBDOMAIN"
},
{
"key": "FRESHSERVICE_API_KEY"
}
],
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.1.0",
"description": "Tools that enable LLMs to interact directly with the Freshservice API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://{freshservice_subdomain}.freshservice.com/api/v2/business_hours/{business_hours_id}",
"http_method": "GET",
"headers": {},
"parameters": [
{
"name": "business_hours_id",
"tool_parameter_name": "business_hours_configuration_id",
"description": "ID of Business Hours configuration to retrieve",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of Business Hours configuration to retrieve"
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "FRESHSERVICE_SUBDOMAIN",
"parameter_name": "freshservice_subdomain",
"accepted_as": "path",
"formatted_value": null,
"description": "",
"is_auth_token": false
},
{
"arcade_key": "FRESHSERVICE_API_KEY",
"parameter_name": "username",
"accepted_as": "basic_auth_username",
"formatted_value": null,
"description": "",
"is_auth_token": false
}
],
"request_body_spec": null,
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}