确认应用的设置反映到正式环境中的处理进度

aki发表于:2019年07月30日 12:31:48更新于:2021年08月09日 16:11:32

应用的设置要反映到正式环境里,需要一定的时间。使用此API可以查看处理的进度。

URI

https://(子域名).cybozu.cn/k/v1/preview/app/deploy.json

来宾空间的应用

https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/preview/app/deploy.json

HTTP方法

GET

必要的访问权限

应用的管理权限

请求参数

参数名要指定的值必须说明
apps数组必须用数值或字符串的数组形式指定应用ID。最多可以指定300条。
指定来宾空间的应用时,只能指定同一个来宾空间内的应用。

请求范例

头部

GET /k/v1/preview/app/deploy.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

{    
  "apps": [    
      8,    
      9,    
      10    
  ]    
}

应答参数

参数名称值的类型说明
apps数组由处理状况的对象组成的数组。
apps[].app字符串应用的ID。
apps[].status字符串处理的状况。
  • PROCESSING:
    表示正在处理。

  • SUCCESS:
    表示处理已完成。

  • FAIL:
    表示处理失败。

  • CANCEL:
    表示由于其他应用的处理失败导致处理被取消。

应答的范例

{    
  "apps": [    
        {    
           "app": "8",    
           "status": "PROCESSING"    
        },    
        {    
           "app": "9",    
           "status": "PROCESSING"    
        },    
        {    
           "app": "10",    
           "status": "PROCESSING"    
        }    
  ]    
}


JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {    
    "apps": [1, 1001]    
};

kintone.api(kintone.api.url('/k/v1/preview/app/deploy', true), 'GET', body, function(resp) {    
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var params = '?' + 'apps[0]=1' + '&' + 'apps[1]=1001';
var url = 'https://{subdomain}.cybozu.cn/k/v1/preview/app/deploy.json' + params;
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
    if (xhr.status === 200) {
        // success
        console.log(JSON.parse(xhr.responseText));
    } else {
        // error
        console.log(JSON.parse(xhr.responseText));
    }
};
xhr.send();