接口文档更新

zhang

2026-03-26 89142d1827dc136c8451b14e4bf44ef734e38760

接口文档更新

 open-rcs/components/content/content-interface-word.html

@@ -1516,6 +1516,85 @@

                        }
                    }
                },
                {
                    "apiId": "api-task-error",
                    "name": "上报小车故障信息接口",
                    "description": "上报小车故障信息接口",
                    "isCommon": false,
                    "method": "POST",
                    "url": "上游系统提供",
                    "menu": {
                        "category": "上报小车故障信息接口",
                        "order": 7
                    },
                    "request": {
                        "parameters": [
                            {
                                "name": "agvId",
                                "type": "string",
                                "required": true,
                                "description": "小车编号",
                                "default": "1001"
                            },
                            {
                                "name": "faultNo",
                                "type": "string",
                                "required": true,
                                "description": "故障码",
                                "default": "1001"
                            },
                            {
                                "name": "faultName",
                                "type": "string",
                                "required": true,
                                "description": "故障名称",
                                "default": "1001"
                            },
                            {
                                "name": "timestamp",
                                "type": "long",
                                "required": true,
                                "description": "时间戳",
                                "default": "1234567891231"
                            }
                        ],
                        "example": {
                            "agvId": "1",
                            "faultNo":"异常码",
                            "faultName": "异常名称",
                            "timestamp":"时间"
                        }
                    },
                    "response": {
                        "parameters": [
                            {
                                "name": "code",
                                "type": "integer",
                                "description": "返回编号，200表示成功，1~N表示失败"
                            },
                            {
                                "name": "message",
                                "type": "string",
                                "description": "返回消息，请求成功表示成功，内容为详细的错误描述"
                            },
                            {
                                "name": "data",
                                "type": "object",
                                "description": "返回的数据结构"
                            },
                            {
                                "name": "timestamp",
                                "type": "integer",
                                "description": "时间戳"
                            }
                        ],
                        "example": {
                            "code": 200,
                            "message": "请求成功",
                            "timestamp": 1671526800000
                        }
                    }
                }
            ];


 open-rcs/components/sidebar/sidebar-interface-word.html

@@ -364,6 +364,18 @@
                        "category": "任务管理",
                        "order": 7
                    }
                },
                {
                    "apiId": "api-task-error",
                    "name": "上报小车故障信息接口",
                    "description": "上报小车故障信息接口",
                    "isCommon": false,
                    "method": "POST",
                    "url": "上游系统提供",
                    "menu": {
                        "category": "任务管理",
                        "order": 7
                    }
                }
            ];