UFIDA.U8.Framework.Api

xml文档路径

从API文档中读取控制器描述

所有控制器描述

参数名称

参数说明

Generates an URI-friendly ID for the . E.g. "Get-Values-id_name" instead of "GetValues/{id}?name={name}"

The . The ID as a string.

Use this class to customize the Help Page. For example you can set a custom to supply the documentation or you can provide the samples for the requests/responses.

The controller that will handle requests for the help page.

Sets the documentation provider for help page.

The . The documentation provider.

Sets the objects that will be used by the formatters to produce sample requests/responses.

The . The sample objects.

Sets the sample request directly for the specified media type and action.

The . The sample request. The media type. Name of the controller. Name of the action.

Sets the sample request directly for the specified media type and action with parameters.

The . The sample request. The media type. Name of the controller. Name of the action. The parameter names.

Sets the sample request directly for the specified media type of the action.

The . The sample response. The media type. Name of the controller. Name of the action.

Sets the sample response directly for the specified media type of the action with specific parameters.

The . The sample response. The media type. Name of the controller. Name of the action. The parameter names.

Sets the sample directly for all actions with the specified media type.

The . The sample. The media type.

Sets the sample directly for all actions with the specified type and media type.

The . The sample. The media type. The parameter type or return type of an action.

Specifies the actual type of passed to the in an action. The help page will use this information to produce more accurate request samples.

The . The type. Name of the controller. Name of the action.

Specifies the actual type of passed to the in an action. The help page will use this information to produce more accurate request samples.

The . The type. Name of the controller. Name of the action. The parameter names.

Specifies the actual type of returned as part of the in an action. The help page will use this information to produce more accurate response samples.

The . The type. Name of the controller. Name of the action.

Specifies the actual type of returned as part of the in an action. The help page will use this information to produce more accurate response samples.

The . The type. Name of the controller. Name of the action. The parameter names.

Gets the help page sample generator.

The . The help page sample generator.

Sets the help page sample generator.

The . The help page sample generator.

Gets the model description generator.

The configuration. The

Gets the model that represents an API displayed on the help page. The model is initialized on the first call and cached for subsequent calls.

The . The ID. An

Describes a type model.

Generates model descriptions for given types.

Use this attribute to change the name of the generated for a type.

The model that represents an API displayed on the help page.

Initializes a new instance of the class.

Gets or sets the that describes the API.

Gets or sets the collection that describes the URI parameters for the API.

Gets or sets the documentation for the request.

Gets or sets the that describes the request body.

Gets the request body parameter descriptions.

Gets or sets the that describes the resource.

Gets the resource property descriptions.

Gets the sample requests associated with the API.

Gets the sample responses associated with the API.

Gets the error messages associated with this model.

This class will generate the samples for the help page.

Initializes a new instance of the class.

Gets CLR types that are used as the content of or .

Gets the objects that are used directly as samples for certain actions.

Gets the objects that are serialized as samples by the supported formatters.

Gets factories for the objects that the supported formatters will serialize as samples. Processed in order, stopping when the factory successfully returns a non- object.

Collection includes just initially. Use SampleObjectFactories.Insert(0, func) to provide an override and SampleObjectFactories.Add(func) to provide a fallback.

Gets the request body samples for a given .

The . The samples keyed by media type.

Gets the response body samples for a given .

The . The samples keyed by media type.

Gets the request or response body samples.

The . The value indicating whether the sample is for a request or for a response. The samples keyed by media type.

Search for samples that are provided directly through .

Name of the controller. Name of the action. The parameter names. The CLR type. The formatter. The media type. The value indicating whether the sample is for a request or for a response. The sample that matches the parameters.

Gets the sample object that will be serialized by the formatters. First, it will look at the . If no sample object is found, it will try to create one using (which wraps an ) and other factories in .

The type. The sample object.

Resolves the actual type of passed to the in an action.

The . The type.

Resolves the type of the action parameter or return value when or is used.

The . Name of the controller. Name of the action. The parameter names. The value indicating whether the sample is for a request or a response. The formatters.

Writes the sample object using formatter.

The formatter. The value. The type. Type of the media.

This is used to identify the place where the sample should be applied.

Creates a new based on media type.

The media type.

Creates a new based on media type and CLR type.

The media type. The CLR type.

Creates a new based on , controller name, action name and parameter names.

The . Name of the controller. Name of the action. The parameter names.

Creates a new based on media type, , controller name, action name and parameter names.

The media type. The . Name of the controller. Name of the action. The parameter names.

Gets the name of the controller.

The name of the controller.

Gets the name of the action.

The name of the action.

Gets the media type.

The media type.

Gets the parameter names.

Gets the .

This represents an image sample on the help page. There's a display template named ImageSample associated with this class.

Initializes a new instance of the class.

The URL of an image.

This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.

This class will create an object of a given type and populate it with sample data.

Generates an object for a given type. The type needs to be public, have a public default constructor and settable public properties/fields. Currently it supports the following types: Simple types: , , , , , etc. Complex types: POCO types. Nullables: . Arrays: arrays of simple types or complex types. Key value pairs: Tuples: , , etc Dictionaries: or anything deriving from . Collections: , , , , , or anything deriving from or . Queryables: , .

The type. An object of the given type.

Indicates whether the sample is used for request or response

This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.

A custom that reads the API documentation from an XML documentation file.

Initializes a new instance of the class.

The physical path to XML document.

公共服务

日志对象

获取加密字符串

获取解密字符串

获取对接账套设置

新增对接账套设置

更新对接账套设置

获取对接账套设置列表

基础资料

日志组件

查询存货档案

查询计量单位档案

查询计量单位组档案

查询部门档案

查询仓库档案

查询存货分类档案

查询供应商档案

查询供应商分类档案

查询客户档案

查询客户分类档案

查询人员档案

查询标准工序资料

基础档案查询

应收应付管理

日志组件

应收应付单据保存接口

系统号单据类型编码模块号报文业务日期

收付款单保存

系统号单据类型编码报文数据

票据保存

系统号模块号业务日期报文数据

平台功能

日志组件

U8登录接口

系统号登录参数

U8登录接口

用户令牌

获取U8密码

获取对接账套设置

获取加密字符串

获取解密字符串

注册对接系统

更新对接系统

获取对接系统列表

上传配置

下载配置

查询日志

生产订单

日志组件

查询特定单据部分

系统号单据类型编码查询条件查询所属区域 H:表头，B:表体, L:列表

采购管理

日志组件

保存单据

系统号单据类型编码报文红蓝标识:True,蓝字发票类型(普通发票 ppurbill,专用发票 purbill,运费发票 ypurbill);到货单类型(到货单 0,退货单 1,拒收单 2) 业务类型:普通采购,直运采购,受托代销单据状态:2新增,1修改,0非编辑 CS 0,BS 1;一般CS 为空

审核单据(单号)

系统号单据类型编码单号红蓝标识:True,蓝字发票类型(普通发票 ppurbill,专用发票 purbill,运费发票 ypurbill);到货单类型(到货单 0,退货单 1,拒收单 2) 业务类型:普通采购,直运采购,受托代销 CS 0,BS 1;一般CS 为空

审核单据(ID)

系统号单据类型编码单据ID 红蓝标识:True,蓝字发票类型(普通发票 ppurbill,专用发票 purbill,运费发票 ypurbill);到货单类型(到货单 0,退货单 1,拒收单 2) 业务类型:普通采购,直运采购,受托代销 CS 0,BS 1;一般CS 为空

审核单据(批量)

系统号单据类型编码报文红蓝标识:True,蓝字发票类型(普通发票 ppurbill,专用发票 purbill,运费发票 ypurbill);到货单类型(到货单 0,退货单 1,拒收单 2) 业务类型:普通采购,直运采购,受托代销 CS 0,BS 1;一般CS 为空

弃审单据(单号)

弃审单据(ID)

弃审单据(批量)

删除单据(单号)

删除单据(ID)

删除单据(批量)

查询特定单据部分

系统号单据类型编码查询条件查询所属区域 H:表头，B:表体, L:列表

日志组件

保存单据

系统号单据类型编码报文单据状态:0新增,1修改

查询特定单据部分

系统号单据类型编码查询条件查询所属区域 H:表头，B:表体, L:列表

车间管理

日志组件

缓存组件

保存报工单

系统号单据类型编码报文数据

保存报工单

单据类型编码报文数据

保存订单报工

系统号报文数据

保存订单报工

报文数据

保存工序报工

系统号报文数据

保存工序报工

报文数据

保存转移报工

系统号报文数据

保存转移报工

报文数据

删除报工单

系统号单据类型编码报文数据

删除报工单

单据类型编码报文数据

删除订单报工

系统号报文数据

删除订单报工

报文数据

删除工序报工

系统号报文数据

删除工序报工

报文数据

删除转移报工

系统号报文数据

删除转移报工

报文数据

审核报工单

系统号单据类型编码报文数据

审核报工单

单据类型编码报文数据

审核订单报工

系统号报文数据

审核订单报工

报文数据

审核工序报工

系统号报文数据

审核工序报工

报文数据

审核转移报工

系统号报文数据

审核转移报工

报文数据

弃审报工

系统号单据类型编码报文数据

弃审报工

单据类型编码报文数据

弃审订单报工

系统号报文数据

弃审订单报工

报文数据

弃审工序报工

系统号报文数据

弃审工序报工

报文数据

弃审转移报工

系统号报文数据

弃审转移报工

报文数据

库存管理

日志组件

新增单据

系统号单据类型编码报文是否控制可用量是否检查可用量是否红字单据传空字符串是否远程是否生成时审核

新增单据

单据类型编码报文是否控制可用量是否检查可用量是否红字单据传空字符串是否远程是否生成时审核

审核单据(单号)

系统号单据类型编码单据编号是否控制可用量是否检查可用量是否列表

审核单据(ID)

系统号单据类型编码单据ID 是否控制可用量是否检查可用量是否列表

审核单据(批量)

系统号单据类型编码报文是否控制可用量是否检查可用量是否列表

弃审单据(单号)

系统号单据类型编码单据编号是否控制可用量是否检查可用量是否列表

弃审单据(ID)

系统号单据类型编码单据ID 是否控制可用量是否检查可用量是否列表

弃审单据(批量)

系统号单据类型编码报文是否控制可用量是否检查可用量是否列表

删除单据(单号)

系统号单据类型编码单据编号是否控制可用量是否检查可用量是否列表

删除单据(ID)

系统号单据类型编码单据ID 是否控制可用量是否检查可用量是否列表

删除单据(批量)

系统号单据类型编码报文是否控制可用量是否检查可用量是否列表

查询特定单据部分

系统号单据类型编码查询条件查询所属区域 H:表头，B:表体, L:列表

审批流

日志组件

提交审批流(单号)

系统注册号单据类型编码单据编号审批事件是否UAP单据

提交审批流(单号)

系统注册号单据类型编码单据编号审批事件是否UAP单据

提交审批流(ID)

单据类型编码单据ID 系统注册号审批事件是否UAP单据

提交审批流(ID)

单据类型编码单据ID 系统注册号审批事件是否UAP单据

登录参数

用户名

密码

登录日期,影响各接口制单的默认日期

用户令牌参数

用户令牌

登录输出参数

系统号

用户令牌

登录参数

缺少程序集全局处理事件

报工单删除参数

批量审核弃审参数

查询参数

卸载应用程序域

公共帮助类

读取对应配置

解密

加密

获取数据库配置信息

获取连接对象

获取登录参数

获取用户令牌

用户令牌

跨域加载

构造函数

登录参数

保存

单据类型编码数据包

批量保存

单据类型编码数据包