BOS标准API接口开发指南 V0.8.pdf

BOS 标准API 接口开发指南 V0.8.doc 摘要 本文用于描述Portal 、BOS 的实时接口，能够支持应用程序通过HTTP 请求的方式操作业 务数据，完成数据的更新和检索等操作。接口以 REST 模式设计，以 JSON ，而不是XML 为主要数据封装格式。 目录 1.1 概述2 1.1.1 设计思想2 1.1.2 Portal 、BOS 框架简介2 1.2 身份认证3 1.3 数据格式3 1.3.1 必选参数3 1.3.2 业务参数3 1.3.3 返回内容4 1.4 命令4 1.4.1 ObjectCreate5 1.4.2 ObjectModify 5 1.4.3 ObjectDelete5 1.4.4 ObjectSubmit6 1.4.5 ObjectUnsubmit 6 1.4.6 ProcessOrder 6 1.4.7 ExecuteWebAction 8 1.4.8 Import 8 1.4.9 Query9 1.4.10 GetObject 10 1.4.11 ExecuteSQL 11 1.4.12 ExecuteBatch 12 1.4.13 ExecuteAudit 12 1.4.14 SendSMS 12 第 1 页 共 13 页 BOS 标准API 接口开发指南 V0.8.doc 1.1 概述 1.1.1 设计思想 我们将可快速开发作为首要设计出发点。 目前的web 接口主要有以下几种方式  xml-rpc  soap  rest 作为轻量级的接口设计模型，rest 具有开发快速，接口完全自定义的特点，考虑以此模式进 行。 由于网站接口的上传和下载数据都比较大，封装这些数据的方法在XML 和 JSON 之间考 虑，JSON 的特点就是简单，相比 XML 有以下问题： 1. 没有命名空间 namespace 2. 不像xml 那样区分属性attribute 和元素element 3. 不支持属性的排放顺序控制 我们的系统里不存在多个namespace ，且都可以element 来显示，另外用数组来控制元素间 的顺序，以JSON 来封装数据是可行的。 在服务器上给出专用URL 来处理所有接口内容: /servlets/binserv/Rest 同时在服务器以下位置可以获取到与业务单据相关的接口内容说明： http:/ /html/nds/schema/resthome.jsp 在以下位置进行数据封装测试： /html/nds/schema/testrest.jsp 1.1.2 Portal、BOS框架简介 数据描述 Portal 底层的表一般包括主键(PK)和候选键（AK ）, 显示键（DK ）和业务字段。 PK: 统一命名为ID, NUMBER(10) AK: 一般为字符串，在一个公司帐套内唯一（PORTAL\BOS 支持多公司帐套），唯一性主要 通过数据库的UNIQUE INDEX 实现。 DK