[ { "mods": [ { "description": "登录", "name": "auth", "interfaces": [ { "description": "当前用户", "name": "currentUser", "method": "get", "path": "/auth/current-user", "response": { "typeArgs": [], "typeName": "AuthUser", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] }, { "description": "登录", "name": "login", "method": "post", "path": "/auth/login", "response": { "typeArgs": [], "typeName": "AuthUser", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "LoginDTO", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "登出", "name": "logout", "method": "post", "path": "/auth/logout", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] } ] } ], "name": "auth", "baseClasses": [ { "name": "AuthUser", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "anonymous", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "avatar", "description": "用户头像", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "email", "description": "邮箱", "required": false }, { "dataType": { "typeArgs": [], "typeName": "NutMap", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "extInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "fullName", "description": "姓名", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "mobile", "description": "电话", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "password", "description": "密码", "required": true }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "permissions", "description": "权限列表", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "refreshToken", "description": "jwt refreshToken", "required": true }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "roles", "description": "角色列表", "required": true }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'MALE'", "'FEMALE'"], "typeProperties": [] }, "name": "sex", "description": "性别", "required": false }, { "dataType": { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "sexInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "token", "description": "jwt Token", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "userName", "description": "用户名", "required": true } ] }, { "description": "枚举码本", "name": "Codebook", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "码本编码", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "码本名称", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "码本值", "required": true } ] }, { "description": "全局错误", "name": "GlobalError", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "错误码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "message", "description": "错误信息", "required": false } ] }, { "description": "登录实体", "name": "LoginDTO", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "captcha", "description": "验证码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "mobile", "description": "手机号", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "password", "description": "密码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'ACCOUNT'", "'WECHAT'"], "typeProperties": [] }, "name": "type", "description": "登录类型", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "userName", "description": "用户名", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "uuid", "description": "uuid", "required": false } ] }, { "name": "NutMap", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, { "typeArgs": [], "typeName": "object", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "ObjectMap", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "all", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "empty", "required": false } ] } ] }, { "mods": [ { "description": "权限", "name": "permission", "interfaces": [ { "description": "批量新增权限", "name": "batchInitPermissions", "method": "post", "path": "/batch-init-permissions", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "增量新增权限", "name": "batchSyncPermissions", "method": "patch", "path": "/batch-sync-permissions", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "增加权限", "name": "add", "method": "post", "path": "/permission", "response": { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "更新权限", "name": "update", "method": "patch", "path": "/permission", "response": { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "权限类型", "name": "types", "method": "get", "path": "/permission/types", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] }, { "description": "权限详情", "name": "detail_2", "method": "get", "path": "/permission/{id}", "response": { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "权限id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "删除权限", "name": "deletePermission", "method": "delete", "path": "/permission/{key}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "权限key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "权限列表", "name": "permissions_2", "method": "get", "path": "/permissions", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "强制拉取", "required": false, "in": "query", "name": "force", "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "权限树", "name": "permissionTree", "method": "get", "path": "/permissions/tree", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "TreeString", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "强制拉取", "required": false, "in": "query", "name": "force", "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] }, { "description": "角色", "name": "role", "interfaces": [ { "description": "增加/编辑角色", "name": "saveOrUpdateRole", "method": "put", "path": "/role", "response": { "typeArgs": [], "typeName": "Role", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Role", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "角色详情", "name": "detail_1", "method": "get", "path": "/role/{id}", "response": { "typeArgs": [], "typeName": "Role", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "角色id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "删除角色", "name": "deleteRole", "method": "delete", "path": "/role/{key}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "角色key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询用于授权的权限信息", "name": "permissionInfos_1", "method": "get", "path": "/role/{key}/permission-infos", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "PermissionInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "角色key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询角色权限", "name": "permissions_1", "method": "get", "path": "/role/{key}/permissions", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "角色key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "为指定角色授权", "name": "grant_1", "method": "post", "path": "/role/{key}/permissions", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "角色key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "分页查询角色", "name": "roles", "method": "get", "path": "/roles", "response": { "typeArgs": [], "typeName": "IPageRole", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "页码", "required": false, "in": "query", "name": "page", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "页面大小", "required": false, "in": "query", "name": "size", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "搜索关键词", "required": false, "in": "query", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] }, { "description": "用户", "name": "user", "interfaces": [ { "description": "增加/编辑用户", "name": "saveOrUpdateUser", "method": "put", "path": "/user", "response": { "typeArgs": [], "typeName": "User", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "User", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "所有用户", "name": "all", "method": "get", "path": "/user-all", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "User", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] }, { "description": "检查用户名是否存在,true存在,false不存在", "name": "existName", "method": "get", "path": "/user/exist-name", "response": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "query", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "用户性别", "name": "sexes", "method": "get", "path": "/user/sexes", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] }, { "description": "用户详情", "name": "detail", "method": "get", "path": "/user/{id}", "response": { "typeArgs": [], "typeName": "User", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "删除用户", "name": "deleteUser", "method": "delete", "path": "/user/{id}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "重置密码", "name": "resetPassword", "method": "patch", "path": "/user/{name}/password", "response": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户名", "required": true, "in": "path", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询用于授权的权限信息", "name": "permissionInfos", "method": "get", "path": "/user/{name}/permission-infos", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "PermissionInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户名", "required": true, "in": "path", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询用户权限", "name": "permissions", "method": "get", "path": "/user/{name}/permissions", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Permission", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户名", "required": true, "in": "path", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "为指定用户授权", "name": "grant", "method": "post", "path": "/user/{name}/permissions", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户名", "required": true, "in": "path", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询用户权限", "name": "roleInfos", "method": "get", "path": "/user/{name}/role-infos", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "RoleInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户名", "required": true, "in": "path", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "为指定用户设置角色", "name": "grantRole", "method": "post", "path": "/user/{name}/roles", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "用户名", "required": true, "in": "path", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "分页查询用户", "name": "users", "method": "get", "path": "/users", "response": { "typeArgs": [], "typeName": "IPageUser", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "页码", "required": false, "in": "query", "name": "page", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "页面大小", "required": false, "in": "query", "name": "size", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "性别", "required": false, "in": "query", "name": "sex", "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'MALE'", "'FEMALE'"], "typeProperties": [] } }, { "description": "搜索关键词", "required": false, "in": "query", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] } ], "name": "acl", "baseClasses": [ { "description": "枚举码本", "name": "Codebook", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "码本编码", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "码本名称", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "码本值", "required": true } ] }, { "description": "全局错误", "name": "GlobalError", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "错误码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "message", "description": "错误信息", "required": false } ] }, { "name": "IPageRole", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "current", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "pages", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "Role", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "records", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "size", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "total", "required": false } ] }, { "name": "IPageUser", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "current", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "pages", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "User", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "records", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "size", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "total", "required": false } ] }, { "description": "权限", "name": "Permission", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "权限描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "权限key,英文", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "keyPath", "description": "权限keyPath,用来做业务,(父级keyPath.key)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "权限名称,中文用来做标识", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentKey", "description": "父权限key", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'MENU'", "'BUTTON'", "'OTHER'"], "typeProperties": [] }, "name": "type", "description": "权限类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "typeInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "权限信息,包含是否选中标识", "name": "PermissionInfo", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "权限描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "权限key,英文", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "keyPath", "description": "权限keyPath,用来做业务,(父级keyPath.key)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "权限名称,中文用来做标识", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentKey", "description": "父权限key", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "selected", "description": "权限是否选中标识", "required": true }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'MENU'", "'BUTTON'", "'OTHER'"], "typeProperties": [] }, "name": "type", "description": "权限类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "typeInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "角色", "name": "Role", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "角色描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "角色key,英文,用来做业务", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "角色名称,中文用来做标识", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "角色信息,包含是否选中标识", "name": "RoleInfo", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "角色描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "角色key,英文,用来做业务", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "角色名称,中文用来做标识", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "selected", "description": "角色是否选中标识", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "树", "name": "TreeString", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "TreeString", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "children", "description": "下级列表", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "ID", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "名称", "required": true }, { "dataType": { "typeArgs": [], "typeName": "TreeableString", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "originData", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentKey", "description": "父级 ID", "required": false } ] }, { "description": "原始数据", "name": "TreeableString", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentKey", "required": false } ] }, { "description": "用户", "name": "User", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "email", "description": "邮箱", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "fullName", "description": "真实姓名", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "mobile", "description": "手机号", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "用户名", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "password", "description": "密码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'MALE'", "'FEMALE'"], "typeProperties": [] }, "name": "sex", "description": "性别", "required": false }, { "dataType": { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "sexInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] } ] }, { "mods": [ { "description": "码本数据", "name": "dictionary", "interfaces": [ { "description": "增加/编辑码本分组", "name": "saveOrUpdateGroup", "method": "put", "path": "/group", "response": { "typeArgs": [], "typeName": "Group", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Group", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "分组下的数据字典列表", "name": "dictionaries", "method": "get", "path": "/group/{group}/dictionaries", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Dictionary", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "码本分组key", "required": true, "in": "path", "name": "group", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "增加/编辑码本数据", "name": "saveOrUpdateDictionary", "method": "put", "path": "/group/{group}/dictionary", "response": { "typeArgs": [], "typeName": "Dictionary", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "码本分组key", "required": true, "in": "path", "name": "group", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Dictionary", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "删除码本数据", "name": "deleteDictionary", "method": "delete", "path": "/group/{group}/dictionary/{key}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "码本分组key", "required": true, "in": "path", "name": "group", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "码本数据key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "码本分组详情", "name": "groupDetail", "method": "get", "path": "/group/{id}", "response": { "typeArgs": [], "typeName": "Group", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "码本分组id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "删除码本分组", "name": "deleteGroup", "method": "delete", "path": "/group/{key}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "码本分组key", "required": true, "in": "path", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "分页查询码本分组", "name": "groups", "method": "get", "path": "/groups", "response": { "typeArgs": [], "typeName": "IPageGroup", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "页码", "required": false, "in": "query", "name": "page", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "页面大小", "required": false, "in": "query", "name": "size", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "搜索关键词", "required": false, "in": "query", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] } ], "name": "dictionary", "baseClasses": [ { "description": "码本数据", "name": "Dictionary", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "disabled", "description": "禁用标识", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "groupKey", "description": "分组Key", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "index", "description": "序号", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "key", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentKey", "description": "上级Key", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "value", "description": "value", "required": false } ] }, { "description": "全局错误", "name": "GlobalError", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "错误码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "message", "description": "错误信息", "required": false } ] }, { "description": "码本分组", "name": "Group", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "分组描述", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "disabled", "description": "禁用标识", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "key", "description": "分组唯一键", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "分组名称", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "name": "IPageGroup", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "current", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "pages", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "Group", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "records", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "size", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "total", "required": false } ] } ] }, { "mods": [ { "description": "入库/出库 申请单管理", "name": "apply", "interfaces": [ { "description": "分页查询申请列表", "name": "searchPage", "method": "get", "path": "/applies", "response": { "typeArgs": [], "typeName": "IPageApplyDTO", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "页码", "required": false, "in": "query", "name": "page", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "页面大小", "required": false, "in": "query", "name": "size", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "申请类型(1入库 3出库 4盘点)", "required": true, "in": "query", "name": "applyType", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "物料类型", "required": false, "in": "query", "name": "type", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "物料编码", "required": false, "in": "query", "name": "code", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "物料名称", "required": false, "in": "query", "name": "name", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "提交出入库申请单", "name": "saveApply", "method": "put", "path": "/apply", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "ApplyInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询申请单详情", "name": "detail_1", "method": "get", "path": "/apply/{applyId}", "response": { "typeArgs": [], "typeName": "ApplyInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "申请单ID", "required": true, "in": "path", "name": "applyId", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "分页查询盘点列表", "name": "searchAuditPage", "method": "get", "path": "/audit-applies", "response": { "typeArgs": [], "typeName": "IPageApplyForm", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "页码", "required": false, "in": "query", "name": "page", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "页面大小", "required": false, "in": "query", "name": "size", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "盘点类型", "required": false, "in": "query", "name": "auditType", "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'SCAN'", "'MANUAL'"], "typeProperties": [] } }, { "description": "盘点人", "required": false, "in": "query", "name": "taker", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "创建日期", "required": false, "in": "query", "name": "createDate", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "审核状态", "required": false, "in": "query", "name": "reviewResults", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'WAIT_SCAN'", "'WAIT_SUBMIT'", "'WAIT_REVIEW'", "'PASS'", "'REJECT'"], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "提交盘点申请单", "name": "auditApply", "method": "post", "path": "/audit-apply", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "AuditApplyInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "获取盘点结果数据", "name": "getComparisonRes", "method": "get", "path": "/comparison-result/{applyId}", "response": { "typeArgs": [], "typeName": "ComparisonResDTO", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "申请单ID", "required": true, "in": "path", "name": "applyId", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "处理盘点异常数据", "name": "updateReviewResult", "method": "put", "path": "/handle-exceptional-data/{applyId}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "申请单ID", "required": true, "in": "path", "name": "applyId", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "StocktakingScanExceptionalData", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "提交人工盘点数据", "name": "submitManualStock", "method": "post", "path": "/manual/audit-apply", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "ManualStockDetail", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "获取人工盘点数据", "name": "getManualStock", "method": "get", "path": "/manual/data/{applyId}", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "ManualStockDTO", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "申请单ID", "required": true, "in": "path", "name": "applyId", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "提交盘点扫码数据", "name": "saveScanData", "method": "post", "path": "/scan-data/{applyId}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "申请单ID", "required": true, "in": "path", "name": "applyId", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "StocktakingScanDetail", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "提交审核", "name": "submitReview", "method": "post", "path": "/submit-review", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "ReviewDTO", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "获取盘点的待扫码信息", "name": "getWaitScanData", "method": "get", "path": "/wait-scan-data/{applyId}", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "WaitScanInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "申请单ID", "required": true, "in": "path", "name": "applyId", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] }, { "description": "物料管理", "name": "material", "interfaces": [ { "description": "增加/编辑物料", "name": "saveOrUpdateMaterial", "method": "put", "path": "/material", "response": { "typeArgs": [], "typeName": "Material", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Material", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询所有物料列表", "name": "all", "method": "post", "path": "/material/list", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Material", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "类型", "required": false, "in": "query", "name": "type", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "是否赋码", "required": false, "in": "query", "name": "assignRule", "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "物料详情", "name": "detail", "method": "get", "path": "/material/{id}", "response": { "typeArgs": [], "typeName": "Material", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "物料id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "删除物料", "name": "deleteMaterial", "method": "delete", "path": "/material/{id}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "物料id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "批量生成条形码", "name": "generateBarcodes", "method": "post", "path": "/material/{id}/generate-barcodes", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "物料id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "条形码数量", "required": true, "in": "query", "name": "count", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "分页查询物料列表", "name": "materials", "method": "get", "path": "/materials", "response": { "typeArgs": [], "typeName": "IPageMaterial", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "页码", "required": false, "in": "query", "name": "page", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "页面大小", "required": false, "in": "query", "name": "size", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "类型", "required": false, "in": "query", "name": "type", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } }, { "description": "搜索关键词", "required": false, "in": "query", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] }, { "description": "物料类型管理", "name": "type", "interfaces": [ { "description": "增加/更新地区", "name": "addAndModify", "method": "post", "path": "/area", "response": { "typeArgs": [], "typeName": "Type", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "required": true, "in": "body", "name": "requestBody", "dataType": { "typeArgs": [], "typeName": "Type", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "级别", "name": "levels", "method": "get", "path": "/area/levels", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] }, { "description": "类型树", "name": "trees", "method": "get", "path": "/area/trees", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "TypeTree", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [] }, { "description": "删除类型", "name": "deleteArea", "method": "delete", "path": "/area/{id}", "response": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "id", "required": true, "in": "path", "name": "id", "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] }, { "description": "查询类型", "name": "areas", "method": "get", "path": "/areas", "response": { "typeArgs": [ { "typeArgs": [], "typeName": "Type", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "parameters": [ { "description": "搜索关键词", "required": false, "in": "query", "name": "key", "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } } ] } ] } ], "name": "material", "baseClasses": [ { "name": "ApplyDTO", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applicant", "description": "申请人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyDate", "description": "申请日期", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyNum", "description": "申请数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'PURCHASE_RECEIPT'", "'RETURN_RECEIPT'", "'LOAN_OUT'", "'AUDIT'", "'SCRAP_OUT'"], "typeProperties": [] }, "name": "applyType", "description": "申请类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyTypeInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "物料编码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "confirmNum", "description": "确认数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "物料名称", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "remark", "description": "备注", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "spec", "description": "物料规格", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "type", "description": "物料类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "typeName", "description": "类型名称", "required": false } ] }, { "description": "申请单明细", "name": "ApplyDetail", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "申请单ID", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "assignRule", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "confirmQuantity", "description": "确认数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "exceptionRemark", "description": "异常情况说明", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料Id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "quantity", "description": "申请数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "入库/出库/盘点 申请单", "name": "ApplyForm", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applicant", "description": "申请人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyDate", "description": "申请日期", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'SCAN'", "'MANUAL'"], "typeProperties": [] }, "name": "auditType", "description": "盘点类型(1: 扫码 2: 人工)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "confirm", "description": "是否确认(0: 未确认 1: 已确认)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "reviewRemark", "description": "审核意见", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'WAIT_SCAN'", "'WAIT_SUBMIT'", "'WAIT_REVIEW'", "'PASS'", "'REJECT'"], "typeProperties": [] }, "name": "reviewResult", "description": "审核结果(1-待扫码 2-待提交 3-待审核 4-审核通过 5退回)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "reviewer", "description": "盘点审核人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "taker", "description": "盘点人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'PURCHASE_RECEIPT'", "'RETURN_RECEIPT'", "'LOAN_OUT'", "'AUDIT'", "'SCRAP_OUT'"], "typeProperties": [] }, "name": "type", "description": "类型(1: 采购入库申请 2: 归还入库申请 3: 出库外借申请 4: 盘点申请)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "申请单", "name": "ApplyInfo", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "ApplyDetail", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyDetails", "description": "申请单明细", "required": false }, { "dataType": { "typeArgs": [], "typeName": "ApplyForm", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyForm", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "MaterialStockDetail", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "detailList", "description": "扫码的条码集合", "required": false } ] }, { "description": "申请单", "name": "AuditApplyInfo", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applicant", "description": "申请人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyDate", "description": "申请日期", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'SCAN'", "'MANUAL'"], "typeProperties": [] }, "name": "auditType", "description": "盘点类型(1: 扫码 2: 人工)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "confirm", "description": "是否确认(0: 未确认 1: 已确认)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "ids", "description": "物料ids", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "reviewRemark", "description": "审核意见", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'WAIT_SCAN'", "'WAIT_SUBMIT'", "'WAIT_REVIEW'", "'PASS'", "'REJECT'"], "typeProperties": [] }, "name": "reviewResult", "description": "审核结果(1-待扫码 2-待提交 3-待审核 4-审核通过 5退回)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "reviewer", "description": "盘点审核人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "taker", "description": "盘点人", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'PURCHASE_RECEIPT'", "'RETURN_RECEIPT'", "'LOAN_OUT'", "'AUDIT'", "'SCRAP_OUT'"], "typeProperties": [] }, "name": "type", "description": "类型(1: 采购入库申请 2: 归还入库申请 3: 出库外借申请 4: 盘点申请)", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "types", "description": "物料类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "枚举码本", "name": "Codebook", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "码本编码", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "码本名称", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "码本值", "required": true } ] }, { "name": "ComparisonResDTO", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "StockDetailInfo", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "details", "description": "库存明细", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "StocktakingScanExceptionalData", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "exceptionalData", "description": "差异数据", "required": false } ] }, { "description": "全局错误", "name": "GlobalError", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "错误码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "message", "description": "错误信息", "required": false } ] }, { "name": "IPageApplyDTO", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "current", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "pages", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "ApplyDTO", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "records", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "size", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "total", "required": false } ] }, { "name": "IPageApplyForm", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "current", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "pages", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "ApplyForm", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "records", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "size", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "total", "required": false } ] }, { "name": "IPageMaterial", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "current", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "pages", "required": false }, { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "Material", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "records", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "size", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "total", "required": false } ] }, { "name": "ManualStockDTO", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "申请id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "编码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "manualStock", "description": "手动核实库存数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "msg", "description": "异常原因", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "名称", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "price", "description": "价格", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "spec", "description": "规格", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "stock", "description": "库存数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "type", "description": "类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "typeName", "required": false } ] }, { "description": "人工手动核实物料库存明细", "name": "ManualStockDetail", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "申请id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "manualStock", "description": "手动核实库存数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "msg", "description": "异常原因", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "stock", "description": "库存数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "物料信息", "name": "Material", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "boolean", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "assignRule", "description": "是否赋码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "code", "description": "编码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "description", "description": "备注", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "名称", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "price", "description": "价格", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "spec", "description": "规格", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "stock", "description": "库存数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "type", "description": "类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "typeName", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "物料明细数据表", "name": "MaterialStockDetail", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "入库申请单", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "barcode", "description": "条码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料ID", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'IN'", "'OUT'", "'OFF'", "'LOST'"], "typeProperties": [] }, "name": "status", "description": "状态", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "异常数据列表", "name": "ReviewDTO", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "申请单", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "remark", "description": "审核意见", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'WAIT_SCAN'", "'WAIT_SUBMIT'", "'WAIT_REVIEW'", "'PASS'", "'REJECT'"], "typeProperties": [] }, "name": "reviewResult", "description": "审核结果", "required": false } ] }, { "description": "库存明细", "name": "StockDetailInfo", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialCode", "description": "物料编码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料名称", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialName", "description": "物料名称", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "stockReal", "description": "实际库存(明细数据中统计来的)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "stockTotal", "description": "在存总数(物料表)", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "stockTotalScan", "description": "扫码数量", "required": false } ] }, { "description": "扫码盘点明细表(记录历次盘点扫码的数据)", "name": "StocktakingScanDetail", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "申请单id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "barcode", "description": "条码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料ID", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "扫码盘点异常数据表", "name": "StocktakingScanExceptionalData", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "applyId", "description": "申请单id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "barcode", "description": "条码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'MARK_LOST'", "'MARK_KEEP'", "'MARK_RETURN'", "'MARK_DISCARD'", "'MARK_NEW'"], "typeProperties": [] }, "name": "exceptionHandle", "description": "异常处理", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'SOCK_IN_BUT_SCAN_NOT_EXIST'", "'SOCK_OUT_BUT_SCAN_EXIST'", "'SOCK_NOT_EXIST_BUT_SCAN_EXIST'"], "typeProperties": [] }, "name": "exceptionReason", "description": "异常类型", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialId", "description": "物料ID", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialName", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "remark", "description": "备注", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "description": "类型", "name": "Type", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "createdTime", "required": false }, { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "id", "required": false }, { "dataType": { "typeArgs": [], "typeName": "", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": ["'ONE'", "'TWO'"], "typeProperties": [] }, "name": "level", "description": "类型级别", "required": true }, { "dataType": { "typeArgs": [], "typeName": "Codebook", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "levelInfo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "name", "description": "类型名称", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "no", "description": "类型编码", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentNo", "description": "上级类型编码", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "updatedTime", "required": false } ] }, { "name": "TypeTree", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [ { "typeArgs": [], "typeName": "TypeTree", "isDefsType": true, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] } ], "typeName": "Array", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "children", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "label", "description": "类型名称", "required": true }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "parentNo", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "value", "description": "类型编码", "required": true } ] }, { "name": "WaitScanInfo", "templateArgs": [], "properties": [ { "dataType": { "typeArgs": [], "typeName": "number", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "count", "description": "物料数量", "required": false }, { "dataType": { "typeArgs": [], "typeName": "string", "isDefsType": false, "templateIndex": -1, "compileTemplateKeyword": "#/definitions/", "enum": [], "typeProperties": [] }, "name": "materialName", "description": "物料名称", "required": false } ] } ] } ]