{ "name": "UpdateChangeRequest", "fully_qualified_name": "FreshserviceApi.UpdateChangeRequest@1.0.0", "description": "Update an existing Change request in Freshservice.\n\nUse this tool to modify the details of an existing Change request in Freshservice. Useful for updating information or status of Change requests.", "toolkit": { "name": "ArcadeFreshserviceApi", "description": null, "version": "1.0.0" }, "input": { "parameters": [ { "name": "change_request_id", "required": true, "description": "The unique identifier for the Change request to be updated.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "ID of change request to update" }, "inferrable": true, "http_endpoint_parameter_name": "change_id" }, { "name": "update_details", "required": true, "description": "JSON object with updated change request details, including fields like 'id', 'subject', 'priority', 'status', etc.", "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 identifier of the change" }, "requester_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier of the initiator of the change" }, "agent_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier of the agent to whom the change is assigned" }, "group_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier of the agent group to which the change is assigned" }, "priority": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Priority of the change 1-Low, 2-Medium, 3-High, 4-Urgent" }, "impact": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Impact of the change 1-Low, 2-Medium, 3-High" }, "status": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Status identifier of the change. Open -> 1, Planning -> 2, Approval -> 3, Pending Release -> 4, Pending Review -> 5, closed -> 6" }, "risk": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Risk of the change 1-Low, 2-Medium, 3-High, 4-Very High" }, "change_type": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Type of the change 1-minor, 2-standard, 3-major, 4-emergency" }, "approval_status": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Approval status of the change 1-Requested, 2-Approved, 3-Rejected 4-Not_Requested" }, "subject": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Subject of the change" }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Short description of the change in HTML format" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Short description of the change in plain text format" }, "planned_start_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change is starting" }, "planned_end_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change is ending" }, "project_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the associated project" }, "department_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the department initiating the change" }, "category": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Category of the change" }, "sub_category": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Sub-category of the change" }, "item_category": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Item of the change" }, "created_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change was created" }, "updated_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change was last updated" }, "associated_release": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the associated release" }, "assets": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_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)" } }, "description": "Assets associated with the Ticket" }, "associated_problems": { "val_type": "array", "inner_val_type": "integer", "enum": null, "properties": null, "inner_properties": null, "description": "Unique IDs of the problems associated with the change request" }, "incidents_caused_by_change": { "val_type": "array", "inner_val_type": "integer", "enum": null, "properties": null, "inner_properties": null, "description": "Unique IDs of the incidents caused by this change request" }, "tickets_initiating_change": { "val_type": "array", "inner_val_type": "integer", "enum": null, "properties": null, "inner_properties": null, "description": "Unique IDs of the tickets initiating this change request" }, "associated_project": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Id of the associated release" }, "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" }, "planning_fields": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "reason_for_change": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Reason for change" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Reason for change in plain text format" } }, "inner_properties": null, "description": null }, "impact": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Impact" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Impact in plain text format" } }, "inner_properties": null, "description": null }, "rollout_plan": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Rollout Plan" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Rollout plan in plain text format" } }, "inner_properties": null, "description": null }, "backout_plan": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Backout Plan" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Backout plan in plain text format" } }, "inner_properties": null, "description": null } }, "inner_properties": null, "description": null }, "maintenance_window": { "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 identifier of the Change Window" }, "name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Name of the Change Window" }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Description of the Change Window" }, "window_start_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is starting" }, "window_end_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is ending" } }, "inner_properties": null, "description": null }, "black_out_window": { "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 identifier of the Change Window" }, "name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Name of the Change Window" }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Description of the Change Window" }, "window_start_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is starting" }, "window_end_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is ending" } }, "inner_properties": null, "description": null } }, "inner_properties": null, "description": "change details that needs to be updated" }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'update-change'.", "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/changes/{change_id}", "http_method": "PUT", "headers": {}, "parameters": [ { "name": "change_id", "tool_parameter_name": "change_request_id", "description": "ID of change request to update", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "ID of change request to update" }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "requestBody", "tool_parameter_name": "update_details", "description": "change details that needs to be updated", "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 identifier of the change" }, "requester_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier of the initiator of the change" }, "agent_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier of the agent to whom the change is assigned" }, "group_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier of the agent group to which the change is assigned" }, "priority": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Priority of the change 1-Low, 2-Medium, 3-High, 4-Urgent" }, "impact": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Impact of the change 1-Low, 2-Medium, 3-High" }, "status": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Status identifier of the change. Open -> 1, Planning -> 2, Approval -> 3, Pending Release -> 4, Pending Review -> 5, closed -> 6" }, "risk": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Risk of the change 1-Low, 2-Medium, 3-High, 4-Very High" }, "change_type": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Type of the change 1-minor, 2-standard, 3-major, 4-emergency" }, "approval_status": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Approval status of the change 1-Requested, 2-Approved, 3-Rejected 4-Not_Requested" }, "subject": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Subject of the change" }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Short description of the change in HTML format" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Short description of the change in plain text format" }, "planned_start_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change is starting" }, "planned_end_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change is ending" }, "project_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the associated project" }, "department_id": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the department initiating the change" }, "category": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Category of the change" }, "sub_category": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Sub-category of the change" }, "item_category": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Item of the change" }, "created_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change was created" }, "updated_at": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which change was last updated" }, "associated_release": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique ID of the associated release" }, "assets": { "val_type": "array", "inner_val_type": "json", "enum": null, "properties": null, "inner_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)" } }, "description": "Assets associated with the Ticket" }, "associated_problems": { "val_type": "array", "inner_val_type": "integer", "enum": null, "properties": null, "inner_properties": null, "description": "Unique IDs of the problems associated with the change request" }, "incidents_caused_by_change": { "val_type": "array", "inner_val_type": "integer", "enum": null, "properties": null, "inner_properties": null, "description": "Unique IDs of the incidents caused by this change request" }, "tickets_initiating_change": { "val_type": "array", "inner_val_type": "integer", "enum": null, "properties": null, "inner_properties": null, "description": "Unique IDs of the tickets initiating this change request" }, "associated_project": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Id of the associated release" }, "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" }, "planning_fields": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "reason_for_change": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Reason for change" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Reason for change in plain text format" } }, "inner_properties": null, "description": null }, "impact": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Impact" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Impact in plain text format" } }, "inner_properties": null, "description": null }, "rollout_plan": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Rollout Plan" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Rollout plan in plain text format" } }, "inner_properties": null, "description": null }, "backout_plan": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": { "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Backout Plan" }, "description_text": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Backout plan in plain text format" } }, "inner_properties": null, "description": null } }, "inner_properties": null, "description": null }, "maintenance_window": { "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 identifier of the Change Window" }, "name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Name of the Change Window" }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Description of the Change Window" }, "window_start_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is starting" }, "window_end_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is ending" } }, "inner_properties": null, "description": null }, "black_out_window": { "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 identifier of the Change Window" }, "name": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Name of the Change Window" }, "description": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Description of the Change Window" }, "window_start_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is starting" }, "window_end_date": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Timestamp at which Change Window is ending" } }, "inner_properties": null, "description": null } }, "inner_properties": null, "description": "change details that needs to be updated" }, "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\": \"change details that needs to be updated\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the change\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 140002342342\n },\n \"requester_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the initiator of the change\",\n \"format\": \"int64\",\n \"example\": 14000234234\n },\n \"agent_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the agent to whom the change is assigned\",\n \"format\": \"int64\",\n \"example\": 1400023498\n },\n \"group_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the agent group to which the change is assigned\",\n \"format\": \"int64\",\n \"example\": 1400097572\n },\n \"priority\": {\n \"type\": \"integer\",\n \"description\": \"Priority of the change 1-Low, 2-Medium, 3-High, 4-Urgent\",\n \"format\": \"string\",\n \"example\": 2\n },\n \"impact\": {\n \"type\": \"integer\",\n \"description\": \"Impact of the change 1-Low, 2-Medium, 3-High\",\n \"format\": \"string\",\n \"example\": 1\n },\n \"status\": {\n \"type\": \"integer\",\n \"description\": \"Status identifier of the change. Open -> 1, Planning -> 2, Approval -> 3, Pending Release -> 4, Pending Review -> 5, closed -> 6\",\n \"format\": \"int32\",\n \"example\": 1\n },\n \"risk\": {\n \"type\": \"integer\",\n \"description\": \"Risk of the change 1-Low, 2-Medium, 3-High, 4-Very High\",\n \"format\": \"string\",\n \"example\": 1\n },\n \"change_type\": {\n \"type\": \"integer\",\n \"description\": \"Type of the change 1-minor, 2-standard, 3-major, 4-emergency\",\n \"format\": \"string\",\n \"example\": 1\n },\n \"approval_status\": {\n \"type\": \"integer\",\n \"description\": \"Approval status of the change 1-Requested, 2-Approved, 3-Rejected 4-Not_Requested\",\n \"format\": \"string\",\n \"readOnly\": true,\n \"example\": 1\n },\n \"subject\": {\n \"type\": \"string\",\n \"description\": \"Subject of the change\",\n \"example\": \"Replace Macbook\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Short description of the change in HTML format\",\n \"example\": \"

Replace damaged Macbook

\"\n },\n \"description_text\": {\n \"type\": \"string\",\n \"description\": \"Short description of the change in plain text format\",\n \"readOnly\": true,\n \"example\": \"Replace damaged Macbook\"\n },\n \"planned_start_date\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which change is starting\",\n \"format\": \"date-time\",\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"planned_end_date\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which change is ending\",\n \"format\": \"date-time\",\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"project_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the associated project\",\n \"format\": \"int64\",\n \"example\": 1400023894\n },\n \"department_id\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the department initiating the change\",\n \"format\": \"int64\",\n \"example\": 14000495482\n },\n \"category\": {\n \"type\": \"string\",\n \"description\": \"Category of the change\",\n \"example\": \"Hardware\"\n },\n \"sub_category\": {\n \"type\": \"string\",\n \"description\": \"Sub-category of the change\",\n \"example\": \"Computer\"\n },\n \"item_category\": {\n \"type\": \"string\",\n \"description\": \"Item of the change\",\n \"example\": \"Mac\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which change 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 change was last updated\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-22T16:58:45Z\"\n },\n \"associated_release\": {\n \"type\": \"integer\",\n \"description\": \"Unique ID of the associated release\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 140004343\n },\n \"assets\": {\n \"type\": \"array\",\n \"description\": \"Assets associated with the Ticket\",\n \"example\": [\n {\n \"id\": 14000234324,\n \"display_id\": 1453,\n \"name\": \"Hardware-Monitor\"\n }\n ],\n \"items\": {\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 \"associated_problems\": {\n \"type\": \"array\",\n \"description\": \"Unique IDs of the problems associated with the change request\",\n \"readOnly\": true,\n \"example\": [\n 140002394874,\n 140003948543\n ],\n \"items\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n }\n },\n \"incidents_caused_by_change\": {\n \"type\": \"array\",\n \"description\": \"Unique IDs of the incidents caused by this change request\",\n \"readOnly\": true,\n \"example\": [\n 1400034598,\n 1400039485\n ],\n \"items\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n }\n },\n \"tickets_initiating_change\": {\n \"type\": \"array\",\n \"description\": \"Unique IDs of the tickets initiating this change request\",\n \"readOnly\": true,\n \"example\": [\n 1400023984,\n 1400034984\n ],\n \"items\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n }\n },\n \"associated_project\": {\n \"type\": \"integer\",\n \"description\": \"Id of the associated release\",\n \"format\": \"int64\",\n \"readOnly\": true,\n \"example\": 140002394874\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 \"change_choices\": \"First Choice\",\n \"state\": \"TX\"\n }\n },\n \"planning_fields\": {\n \"type\": \"object\",\n \"properties\": {\n \"reason_for_change\": {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Reason for change\",\n \"example\": \"

Reason for change

\"\n },\n \"description_text\": {\n \"type\": \"string\",\n \"description\": \"Reason for change in plain text format\",\n \"readOnly\": true,\n \"example\": \"Reason for Change\"\n }\n },\n \"example\": {\n \"description\": \"
Reason for change
\",\n \"description_text\": \"Reason for change\"\n }\n },\n \"impact\": {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Impact\",\n \"example\": \"

Impact

\"\n },\n \"description_text\": {\n \"type\": \"string\",\n \"description\": \"Impact in plain text format\",\n \"readOnly\": true,\n \"example\": \"Impact\"\n }\n },\n \"example\": {\n \"description\": \"
Impact
\",\n \"description_text\": \"Impact\"\n }\n },\n \"rollout_plan\": {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Rollout Plan\",\n \"example\": \"
Rollout plan
\"\n },\n \"description_text\": {\n \"type\": \"string\",\n \"description\": \"Rollout plan in plain text format\",\n \"readOnly\": true,\n \"example\": \"Rollout Plan\"\n }\n },\n \"example\": {\n \"description\": \"
Rollout plan
\",\n \"description_text\": \"Rollout Plan\"\n }\n },\n \"backout_plan\": {\n \"type\": \"object\",\n \"properties\": {\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Backout Plan\",\n \"example\": \"
Backout plan
\"\n },\n \"description_text\": {\n \"type\": \"string\",\n \"description\": \"Backout plan in plain text format\",\n \"readOnly\": true,\n \"example\": \"Backout Plan\"\n }\n },\n \"example\": {\n \"description\": \"
Backout plan
\",\n \"description_text\": \"Backout Plan\"\n }\n }\n },\n \"example\": {\n \"reason_for_change\": {\n \"description\": \"
Reason for change
\",\n \"description_text\": \"Reason for change\"\n },\n \"impact\": {\n \"description\": \"
Impact
\",\n \"description_text\": \"Impact\"\n },\n \"rollout_plan\": {\n \"description\": \"
Rollout plan
\",\n \"description_text\": \"Rollout Plan\"\n },\n \"backout_plan\": {\n \"description\": \"
Backout plan
\",\n \"description_text\": \"Backout Plan\"\n }\n }\n },\n \"maintenance_window\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the Change Window\",\n \"format\": \"int64\",\n \"example\": 140009348572\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the Change Window\",\n \"readOnly\": true,\n \"example\": \"Router firmware upgrade\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the Change Window\",\n \"readOnly\": true,\n \"example\": \"Router firmware upgrade\"\n },\n \"window_start_date\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which Change Window is starting\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"window_end_date\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which Change Window is ending\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-25T11:30:00Z\"\n }\n },\n \"example\": {\n \"id\": 140009348572,\n \"name\": \"Router firmware upgrade\",\n \"description\": \"Router firmware upgrade\",\n \"window_start_date\": \"2021-11-24T11:30:00Z\",\n \"window_end_date\": \"2021-11-25T11:30:00Z\"\n }\n },\n \"black_out_window\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Unique identifier of the Change Window\",\n \"format\": \"int64\",\n \"example\": 140009348572\n },\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the Change Window\",\n \"readOnly\": true,\n \"example\": \"Router firmware upgrade\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"Description of the Change Window\",\n \"readOnly\": true,\n \"example\": \"Router firmware upgrade\"\n },\n \"window_start_date\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which Change Window is starting\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-24T11:30:00Z\"\n },\n \"window_end_date\": {\n \"type\": \"string\",\n \"description\": \"Timestamp at which Change Window is ending\",\n \"format\": \"date-time\",\n \"readOnly\": true,\n \"example\": \"2021-11-25T11:30:00Z\"\n }\n },\n \"example\": {\n \"id\": 140009348572,\n \"name\": \"Router firmware upgrade\",\n \"description\": \"Router firmware upgrade\",\n \"window_start_date\": \"2021-11-24T11:30:00Z\",\n \"window_end_date\": \"2021-11-25T11:30:00Z\"\n }\n }\n }\n }\n }\n },\n \"required\": true\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }