1.75创建空白报告

<< Click to Display Table of Contents >>

当前位置:  部署与集成 > WebAPI 

1.75创建空白报告

复制链接

支持的版本:9.4及以后

请求地址

http://ip:port/bi/api?action=createBlankDB&token=xxxx

请求消息

请求参数

请求参数:xmlData

<?xml version="1.0" encoding="UTF-8"?>

<info>

<overWrite>true</overWrite>

<path>a/b</path>

<type>portalCell</type>

<template>年度运营报告1640774381755_76</template>

<layoutType>1902</layoutType>

</info>

参数描述

参数为节点信息

overWrite(选填):如果新创建的空白报告已经存在,是否覆盖原来的报告,选填“true”表示会覆盖同名报告 ,或者“false”不会覆盖,如果重名则报错,默认为false。

type(选填):报告的类型,参数值包括db、adb、vividdb、portalCell。(10.1开始支持type参数),未填写时为db。

template(选填):想要使用的模板id,填写后可以基于模板创建报告,未填写时直接创建空白报告。

layoutType(选填):组合报告的类型,参数值包括1902、1904、1905、1912。

1902:网格组合。

1904:标签组合。

1905:堆栈组合。

1912:轻应用。

path(必填):空白报告的路径名称。

示例

function createBlankDB() {

  var xml = getXml();

  $.post("http://" + ip + ":" + port + "/" + project + "/api?action=createBlankDB&token=xxxx",

     {xmlData : xml},

     function(result) {

     writeXml(result);

  });

}

响应消息

响应结果

操作成功

<?xml version="1.0" encoding="UTF-8"?>

<results>

  <result>

     <level>1</level>

     <message>操作成功!</message>

  </result>

</results>

操作失败

<?xml version="1.0" encoding="UTF-8"?>

<results>

   <result>

       <level>6</level>

       <message>xmlData数据格式不对,path或overWrite不能为空</message>

   </result>

</results>

文件夹不存在:

<?xml version="1.0" encoding="UTF-8"?>

<results>

   <result>

       <level>6</level>

       <message>创建空白报告失败,具体原因:path-a/b/c, type-16640, token--1, desc-null, access-0 Folder not found: path-a/b, type--32512, token--1, desc-null, access-0, folder-closed</message>

   </result>

</results>

结果描述

响应结果信息为xml,直接parse即可。

level 返回类型,不同数值代表不同返回状态,见附录

message为接口操作结果信息。