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

374 lines
16 KiB
JSON

{
"name": "CreateProblemTimeEntry",
"fully_qualified_name": "FreshserviceApi.CreateProblemTimeEntry@1.0.0",
"description": "Create a new time entry for a problem in Freshservice.\n\nThis tool creates a new time entry on a specified problem in Freshservice. It should be called when you need to log time spent on a problem within the service.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "1.0.0"
},
"input": {
"parameters": [
{
"name": "problem_id",
"required": true,
"description": "The ID of the problem for which the time entry is to be created. Must be an integer value.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of problem for which time entries are to be retrieved"
},
"inferrable": true,
"http_endpoint_parameter_name": "problem_id"
},
{
"name": "time_entry_details",
"required": true,
"description": "Details of the time entry to be created, including IDs, time information, status, and custom fields. It should be a JSON object containing keys like 'id', 'task_id', 'parent_id', 'parent_type', 'start_time', 'time_spent', 'timer_running', 'billable', 'agent_id', 'note', 'created_at', 'updated_at', 'executed_at', and 'custom_fields'.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the time entry"
},
"task_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the task associated with the time entry"
},
"parent_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the parent entity to which the time entry belongs"
},
"parent_type": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Type of the parent entity - [Ticket, Problem, Change, Release, Project]"
},
"start_time": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Time at which the timer started"
},
"time_spent": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Duration of time spent in seconds"
},
"timer_running": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "true if timer is running, false otherwise"
},
"billable": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "true if billable, false otherwise"
},
"agent_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the user who created the time entry"
},
"note": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description note of the time entry"
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the time entry is created"
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Time stamp at which the time entry is updated"
},
"executed_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the time entry is executed"
},
"custom_fields": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Key value pairs containing the names and values of custom fields"
}
},
"inner_properties": null,
"description": "details of time entry to be created"
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'create-problem-time-entry'.",
"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/problems/{problem_id}/time_entries",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "problem_id",
"tool_parameter_name": "problem_id",
"description": "ID of problem for which time entries are to be retrieved",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of problem for which time entries are to be retrieved"
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "time_entry_details",
"description": "details of time entry to be created",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the time entry"
},
"task_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the task associated with the time entry"
},
"parent_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the parent entity to which the time entry belongs"
},
"parent_type": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Type of the parent entity - [Ticket, Problem, Change, Release, Project]"
},
"start_time": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Time at which the timer started"
},
"time_spent": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Duration of time spent in seconds"
},
"timer_running": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "true if timer is running, false otherwise"
},
"billable": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "true if billable, false otherwise"
},
"agent_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Unique ID of the user who created the time entry"
},
"note": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description note of the time entry"
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the time entry is created"
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Time stamp at which the time entry is updated"
},
"executed_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date time at which the time entry is executed"
},
"custom_fields": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Key value pairs containing the names and values of custom fields"
}
},
"inner_properties": null,
"description": "details of time entry to be created"
},
"accepted_as": "body",
"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": "{\n \"description\": \"details of time entry to be created\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the time entry\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 14702899\n },\n \"task_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the task associated with the time entry\",\n \"format\": \"int64\",\n \"example\": 45\n },\n \"parent_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the parent entity to which the time entry belongs\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 500\n },\n \"parent_type\": {\n \"type\": \"string\",\n \"description\": \"Type of the parent entity - [Ticket, Problem, Change, Release, Project]\",\n \"example\": \"Ticket\"\n },\n \"start_time\": {\n \"type\": \"string\",\n \"description\": \"Time at which the timer started\",\n \"format\": \"date-time\",\n \"example\": \"2021-10-15T12:31:42Z\"\n },\n \"time_spent\": {\n \"type\": \"string\",\n \"description\": \"Duration of time spent in seconds\",\n \"example\": \"10:15\"\n },\n \"timer_running\": {\n \"type\": \"boolean\",\n \"description\": \"true if timer is running, false otherwise\",\n \"example\": true\n },\n \"billable\": {\n \"type\": \"boolean\",\n \"description\": \"true if billable, false otherwise\",\n \"example\": true\n },\n \"agent_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the user who created the time entry\",\n \"format\": \"int64\",\n \"example\": 14007423\n },\n \"note\": {\n \"type\": \"string\",\n \"description\": \"Description note of the time entry\",\n \"format\": \"text\",\n \"example\": \"Spent time on task\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which the time entry is created\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-10-15T12:31:42Z\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"Time stamp at which the time entry is updated\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-10-15T12:31:42Z\"\n },\n \"executed_at\": {\n \"type\": \"string\",\n \"description\": \"Date time at which the time entry is executed\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-10-15T12:31:00Z\"\n },\n \"custom_fields\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\"\n },\n \"description\": \"Key value pairs containing the names and values of custom fields\",\n \"example\": {\n \"field1\": \"Value 1\",\n \"field2\": \"Value 2\"\n }\n }\n }\n }\n }\n },\n \"required\": true\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}