API概览
数据模块
数据模块接口,包括按记录ID查询、删除和更新数据等接口。通过这些接口,您可以查询对象中的数据,为对象新增数据等。
API |
说明 |
---|---|
按记录ID查询数据。 |
|
按记录ID删除数据。 |
|
按记录ID更新数据。 |
|
按记录ID列表查询数据。 |
|
新增对象数据。 |
|
按记录ID列表删除数据。 |
|
按条件更新数据。 |
|
按条件查询对象数据。 |
|
按条件删除对象数据。 |
|
按条件查询对象记录数。 |
|
批量插入或修改对象数据,若数据包含id进行更新,若数据不含id进行插入。 |
元数据
元数据接口,包括创建对象、服务编排和工作流等接口。通过这些接口,您可以新建对象、新建服务编排对象和新建工作流对象等。
API |
说明 |
---|---|
添加一个Object对象。 |
|
查询所有Object对象。 |
|
按照ID查询Object。 |
|
为object添加自定义字段。 |
|
根据object_id新增trigger。 |
|
根据object_id新增校验validator。 |
|
按object_id新增layout。 |
|
按照field_id查询Field。 |
|
按照object_id查询layout。 |
|
按照layout_id查询Layout。 |
|
按照object_id查询button。 |
|
按照button_id查询Button。 |
|
按照object_id查询trigger。 |
|
按照trigger_id查询Trigger。 |
|
按照object_id查询validator。 |
|
按照validator_id查询validator。 |
|
添加一个flow对象。 |
|
获取匹配查询条件的flow列表。 |
|
按flow_id查询Flow/查询flow_id的入参出参信息。 |
|
根据id修改flow对象。 |
|
按flow_id删除Flow。 |
|
创建一个BPM对象。 |
|
获取匹配查询条件的BPM列表。 |
|
按bpm_id查询BPM对象。 |
|
根据id修改BPM对象。 |
|
按bpm_id删除BPM。 |
|
创建一个Picklist对象。 |
|
查询选项列表值集。 |
|
按picklist_id增加选项列表值集的值。 |
|
根据ID查询选项列表值集或引用该选项列表值集的对象字段列表。 |
|
根据id修改Picklist对象。 |
|
根据ID删除选项列表值集或选项列表值集的值。 |
|
查询当前账号下所有应用。 |
|
根据应用ID查询应用详细信息。 |
|
查询标准页面的列表,仅包含基础信息,如果需要获取标准页面的内容,需要根据 ID 进行查询。 |
|
按view_id查询标准页面。 |
|
查询应用页签的列表。 |
脚本
脚本接口,包括运行、调试和获取脚本签名信息等接口。通过这些接口,您可以运行脚本、对脚本进行调试等。
API |
说明 |
---|---|
运行脚本。 |
|
调试脚本。 |
|
获取脚本签名信息。 |
|
获取脚本内置库的声明。 |
|
获取服务编排的公式。 |
BPM
工作流接口,包括启动、查询和删除工作流等接口。通过这些接口,您可以启动工作流实例、删除工作流实例和挂起/恢复/终止工作流实例等。
API |
说明 |
---|---|
创建并启动一个BPM实例。 |
|
获取当前账号所有的BPM实例信息。 |
|
挂起/恢复/终止一个BPM实例。BPM实例被挂起后,不会在用户的待办任务列表中出现,流程SLA定时器停止,也不会进行任何跟催。恢复后,可继续进行操作。终止操作则强行结束一个BPM实例,可在历史任务中查看。 |
|
删除一个BPM实例。彻底删除一个BPM实例,仅当管理员清除过期数据时可以删除,其他情况不建议删除BPM实例数据。 |
|
设置或修改BPM实例中变量的值, 一次可以修改一个、多个或者所有变量的值。不存在的变量或者只读变量会被忽略。 |
导入导出
对象数据导入导出接口,包括导入数据、导出数据和导入导出元数据等接口。通过这些接口,您可以导入导出对象数据或元数据,实现数据的迁移。
API |
说明 |
---|---|
导出数据表中的具体数据。AstroZero中创建的对象,其内部的数据是支持导出的,该接口支持将对象中的数据按照设定的周期频率、筛选条件进行导出。 |
|
导入数据。导入的数据源为zip包,包中的数据文件应为txt或csv格式,每个文件第一行为数据所属对象信息,第二行为字段名,第三行开始每一行为一条数据记录。 |
|
导出数据表的元数据,即将数据表的各个字段信息导出,但不包含具体的数据记录。 |
|
导入数据表的元数据。若已有数据表的元数据,可使用该功能快速根据元数据创建对象表。 |
|
按照所使用的模板格式,导入数据。使用该功能前,需要创建好可使用的数据导入模板,在模板中定义数据的映射规则,调用接口时需指定模板名称,在该模板中,需要指定对应的操作脚本。 |
连接器
预置连接器接口,包括上传、下载、删除文件和目录等接口。通过这些接口,您可以实现文件的上传、下载和列举目录下文件等。
API |
说明 |
---|---|
将本地文件上传到存储中。使用该API上传文件,默认只会上传到连接器下配置的第一个桶中。 |
|
从存储中下载文件。 |
|
从存储中删除无用的文件。 |
|
从存储中删除某目录。如果目录下不为空,删除目录的同时也会删除该目录下文件。 |
|
列举存储中某目录下文件。 |
|
对于较大文件上传,可以切分成段上传。用户可以在如下的应用场景内(但不仅限于此),使用分段上传的模式:
|
|
endpoint为文件存储地址的前缀,该前缀加上传对象的路径,是实际访问对象的全路径。上传文件中,返回的是上传文件在桶上的路径。通过调用本节接口,返回endpoint,组装起来才是文件完整的访问地址。 |
|
通过调用获取分享Token,可以获取临时Token,用户只要使用该临时Token即可访问文件,不用再使用“access-token”进行鉴权。 |