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

452 lines
19 KiB
JSON

{
"name": "UpdateExistingAsset",
"fully_qualified_name": "FreshserviceApi.UpdateExistingAsset@1.0.0",
"description": "Update the details of an existing asset in Freshservice.\n\nUse this tool to modify the information of an existing asset by its display ID in Freshservice.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "1.0.0"
},
"input": {
"parameters": [
{
"name": "asset_display_id",
"required": true,
"description": "The unique display ID of the asset to be updated in Freshservice.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "display_id"
},
{
"name": "asset_update_details",
"required": true,
"description": "A JSON object containing the details of the asset to be updated, including keys like 'id', 'display_id', 'name', 'description', and others as specified in the API documentation.",
"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": "id of the asset"
},
"display_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "display id of the asset that is used for all operations"
},
"name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Display Name of the Asset"
},
"description": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description of the asset"
},
"asset_type_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Id of the asset type."
},
"impact": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"low",
"medium",
"high"
],
"properties": null,
"inner_properties": null,
"description": "Impact of the asset (accepted values 'high' 'medium' 'low')"
},
"author_type": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Asset created by source"
},
"usage_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"permanent",
"loaner"
],
"properties": null,
"inner_properties": null,
"description": "Usage type of the asset (accepted values are 'permanent' & 'loaner')"
},
"asset_tag": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Asset tag of the asset"
},
"user_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Used by of the asset"
},
"department_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Department of the asset"
},
"location_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Location of the asset"
},
"agent_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Managed by of the asset"
},
"group_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Managed by group of the asset"
},
"assigned_on": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date and time when the asset was assigned"
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the asset was created"
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the asset was last modified"
},
"type_fields": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Fields specific to every asset type (Every asset will have default base fields and type specific fields)"
}
},
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'update-asset'.",
"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/assets/{display_id}",
"http_method": "PUT",
"headers": {},
"parameters": [
{
"name": "display_id",
"tool_parameter_name": "asset_display_id",
"description": "",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "asset_update_details",
"description": "",
"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": "id of the asset"
},
"display_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "display id of the asset that is used for all operations"
},
"name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Display Name of the Asset"
},
"description": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description of the asset"
},
"asset_type_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Id of the asset type."
},
"impact": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"low",
"medium",
"high"
],
"properties": null,
"inner_properties": null,
"description": "Impact of the asset (accepted values 'high' 'medium' 'low')"
},
"author_type": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Asset created by source"
},
"usage_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"permanent",
"loaner"
],
"properties": null,
"inner_properties": null,
"description": "Usage type of the asset (accepted values are 'permanent' & 'loaner')"
},
"asset_tag": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Asset tag of the asset"
},
"user_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Used by of the asset"
},
"department_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Department of the asset"
},
"location_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Location of the asset"
},
"agent_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Managed by of the asset"
},
"group_id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Managed by group of the asset"
},
"assigned_on": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Date and time when the asset was assigned"
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the asset was created"
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp at which the asset was last modified"
},
"type_fields": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Fields specific to every asset type (Every asset will have default base fields and type specific fields)"
}
},
"inner_properties": null,
"description": ""
},
"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 \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"id of the asset\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 14000234324\n },\n \"display_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"display id of the asset that is used for all operations\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 1453\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Display Name of the Asset\",\n \"example\": \"Hardware-Monitor\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the asset\",\n \"example\": \"28-inch Hardware-Monitor\"\n },\n \"asset_type_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"Id of the asset type.\",\n \"format\": \"int64\",\n \"example\": 14000284324\n },\n \"impact\": {\n \"type\": \"string\",\n \"description\": \"Impact of the asset (accepted values 'high' 'medium' 'low')\",\n \"example\": \"low\",\n \"enum\": [\n \"low\",\n \"medium\",\n \"high\"\n ]\n },\n \"author_type\": {\n \"type\": \"string\",\n \"description\": \"Asset created by source\",\n \"readOnly\": true,\n \"example\": \"User\"\n },\n \"usage_type\": {\n \"type\": \"string\",\n \"description\": \"Usage type of the asset (accepted values are 'permanent' & 'loaner')\",\n \"example\": \"loaner\",\n \"enum\": [\n \"permanent\",\n \"loaner\"\n ]\n },\n \"asset_tag\": {\n \"type\": \"string\",\n \"description\": \"Asset tag of the asset\",\n \"example\": \"wxyzabcdefghij\"\n },\n \"user_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"Used by of the asset\",\n \"format\": \"int64\",\n \"example\": 14000234324\n },\n \"department_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"Department of the asset\",\n \"format\": \"int64\",\n \"example\": 14000232343\n },\n \"location_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"Location of the asset\",\n \"format\": \"int64\",\n \"example\": 140006394857\n },\n \"agent_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"Managed by of the asset\",\n \"format\": \"int64\",\n \"example\": 14000234324\n },\n \"group_id\": {\n \"minimum\": 1,\n \"type\": \"integer\",\n \"description\": \"Managed by group of the asset\",\n \"format\": \"int64\",\n \"example\": 14000234939\n },\n \"assigned_on\": {\n \"type\": \"string\",\n \"description\": \"Date and time when the asset was assigned\",\n \"format\": \"date-time\",\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which the asset was created\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which the asset was last modified\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"type_fields\": {\n \"type\": \"object\",\n \"additionalProperties\": true,\n \"description\": \"Fields specific to every asset type (Every asset will have default base fields and type specific 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
}
}