admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/freshservice_api/arcade_freshservice_api/wrapper_tools/CreateNewDepartment.json

355 lines
14 KiB
JSON
Raw Blame History

{
"name": "CreateNewDepartment",
"fully_qualified_name": "FreshserviceApi.CreateNewDepartment@1.0.0",
"description": "Create a new Department in Freshservice.\n\nThis tool is used to create a new department, or company in MSP mode, within Freshservice. Call this tool when you need to add a new organizational unit in the Freshservice platform.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "1.0.0"
},
"input": {
"parameters": [
{
"name": "department_unique_id",
"required": false,
"description": "A unique integer identifier for the department being created.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique identifier of the department"
},
"inferrable": true,
"http_endpoint_parameter_name": "id"
},
{
"name": "department_name",
"required": false,
"description": "The name of the department to be created in Freshservice.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Name of the department"
},
"inferrable": true,
"http_endpoint_parameter_name": "name"
},
{
"name": "department_description",
"required": false,
"description": "Detailed description of the department being created in Freshservice.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description about the department"
},
"inferrable": true,
"http_endpoint_parameter_name": "description"
},
{
"name": "head_user_identifier",
"required": false,
"description": "Unique identifier of the agent or requester who serves as the head of the department.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique identifier of the agent or requester who serves as the head of the department"
},
"inferrable": true,
"http_endpoint_parameter_name": "head_user_id"
},
{
"name": "prime_user_identifier",
"required": false,
"description": "Unique identifier for the primary agent or requester of the department.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique identifier of the agent or requester who serves as the prime user of the department"
},
"inferrable": true,
"http_endpoint_parameter_name": "prime_user_id"
},
{
"name": "department_email_domains",
"required": false,
"description": "Email domains associated with the department, provided as a list of strings.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Email domains associated with the department"
},
"inferrable": true,
"http_endpoint_parameter_name": "domains"
},
{
"name": "department_custom_fields",
"required": false,
"description": "JSON object representing custom fields associated with a Freshservice department entity. This can include fields like additional metadata or specific attributes relevant to the department.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Custom fields that are associated with a Freshservice entity"
},
"inferrable": true,
"http_endpoint_parameter_name": "custom_fields"
},
{
"name": "department_creation_timestamp",
"required": false,
"description": "The timestamp indicating when the department was created, formatted as a string.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the department was created"
},
"inferrable": true,
"http_endpoint_parameter_name": "created_at"
},
{
"name": "last_modified_timestamp",
"required": false,
"description": "Timestamp indicating when the department was last modified. Use ISO 8601 format.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the department was last modified"
},
"inferrable": true,
"http_endpoint_parameter_name": "updated_at"
}
]
},
"output": {
"description": "Response from the API endpoint 'create-department'.",
"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": null,
"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://api.freshservice.com/api/v2/departments",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "id",
"tool_parameter_name": "department_unique_id",
"description": "Unique identifier of the department",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique identifier of the department"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "name",
"tool_parameter_name": "department_name",
"description": "Name of the department",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Name of the department"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "description",
"tool_parameter_name": "department_description",
"description": "Description about the department",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description about the department"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "head_user_id",
"tool_parameter_name": "head_user_identifier",
"description": "Unique identifier of the agent or requester who serves as the head of the department",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique identifier of the agent or requester who serves as the head of the department"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "prime_user_id",
"tool_parameter_name": "prime_user_identifier",
"description": "Unique identifier of the agent or requester who serves as the prime user of the department",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique identifier of the agent or requester who serves as the prime user of the department"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "domains",
"tool_parameter_name": "department_email_domains",
"description": "Email domains associated with the department",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Email domains associated with the department"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "custom_fields",
"tool_parameter_name": "department_custom_fields",
"description": "Custom fields that are associated with a Freshservice entity",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Custom fields that are associated with a Freshservice entity"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "created_at",
"tool_parameter_name": "department_creation_timestamp",
"description": "Timestamp at which the department was created",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the department was created"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "updated_at",
"tool_parameter_name": "last_modified_timestamp",
"description": "Timestamp at which the department was last modified",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the department was last modified"
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [],
"request_body_spec": "{\n \"description\": \"Department that needs to be created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the department\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 14000234324\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the department\",\n \"example\": \"IT Support\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description about the department\",\n \"example\": \"IT Support\"\n },\n \"head_user_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the agent or requester who serves as the head of the department\",\n \"format\": \"int64\",\n \"example\": 14000234324\n },\n \"prime_user_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the agent or requester who serves as the prime user of the department\",\n \"format\": \"int64\",\n \"example\": 14000234324\n },\n \"domains\": {\n \"type\": \"array\",\n \"description\": \"Email domains associated with the department\",\n \"example\": [\n \"support.freshservice.com\"\n ],\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"custom_fields\": {\n \"type\": \"object\",\n \"description\": \"Custom fields that are associated with a Freshservice entity\",\n \"example\": \"\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which the department was created\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which the department was last modified\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n }\n }\n }\n }\n },\n \"required\": true\n}",
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}
Reference in a new issue View git blame Copy permalink