Protocol

HTTPS

URI

https://api.krewdata.grapecity.com/trigger/v1/{ExecutionUnitID}

Format

JSON

Encoding

UTF-8

API List

Requests an access token for requesting execution of execution unit.

The access token has an expiry. If it expires, a new access token is requested.

HTTP Method

POST

URI

https://api.krewdata.grapecity.com/trigger/v1/{ExecutionUnitID}/token

Request Parameters

Example Request

Response

Response code (code), response status (status), and access token (accessToken) are returned if the request is successful. The access token is used in the request parameter of the execution request API and execution status confirmation API.

Example Response

Error Response

Response code (code), response status (status), and error message (description) are returned if request is unsuccessful.

Example Error Response

Requests execution of execution unit using the access token.

Access token can be used just once in the execution request API. You need to obtain a new access token to call the execution request API again.

HTTP Method

POST

URI

https://api.krewdata.grapecity.com/trigger/v1/{ExecutionUnitID}/run

Request Parameters

Example Request

Response

Response code (code), response status (status), and task ID (taskId) are returned if the request is successful.

Example Response

Error Response

Response code (code), response status (status), and error message (description) are returned if If the request is unsuccessful.

Example Error Response

Checks execution status of execution unit.

HTTP Method

POST

URI

https://api.krewdata.grapecity.com/trigger/v1/{ExecutionUnitID}/status

Request Parameters

Example Request

Response

Response code (code), response status (status), execution status of the execution unit (taskStatus), and execution information (flowInfo) of the data editing flow included in the execution unit are returned if the request is successful.

Example Response

If the execution unit is running, taskStatus is returned as "Running".

If the execution unit is executed successful, taskStatus is returned as "Success".

If the execution unit is executed unsuccessful, taskStatus is returned as "Failure". The flowInfo object contains execution result information for each data editing flow.

If an error occurs while running the first data editing flow:

If the data editing flow is not executed and an error occurs due to reasons such as concurrent execution of execution unit not being allowed, timeout, etc:

Error Response

Response code (code), response status (status), and error message (description) are returned if the request is unsuccessful.

Example Error Response

Following sample code demonstrates how to place a Run button in Records page of an app and request execution of the execution unit on click of the button.

In this sample code, Run button is placed in the blank area above the menu on the Records page.

(function () {
  'use strict';
  kintone.events.on('app.record.detail.show', function (event) {
    var url = 'https://api.krewdata.grapecity.com/trigger/v1/abcdefghijklmn';
    var krewdataAppUrl = 'https://yourdomain.cybozu.com/k/123';
    var serialNumber = 'abcdef-jklmno-pqrstu-xyz123-456789';
    // Place a "Run" button
    if (document.getElementById('run_button') !== null) {
      return;
    }
    var runButton = document.createElement('button');
    runButton.id = 'run_button';
    runButton.innerText = 'Run';
    runButton.onclick = async(butotnEvent) => {
      if (window.confirm('Execute the krewData execution unit?')) {
        // Request access token
        var tokenBody = {
          'krewdataAppUrl': krewdataAppUrl,
          'serialNumber': window.btoa(serialNumber)
        };
        var tokenResponse = await sendRequest('token', url, tokenBody);
        console.log(JSON.stringify(tokenResponse));
        // Request execution of the execution unit
        if (tokenResponse.code == 200) {
          var accessToken = tokenResponse.accessToken;
          var runBody = {
            'accessToken': accessToken,
            'user': kintone.getLoginUser().code,
            'appId': event.appId.toString(),
            'record': event.record
          };
          var runResponse = await sendRequest('run', url, runBody);
          console.log(JSON.stringify(runResponse));
          // Check status of the execution unit
          if (runResponse.code == 200) {
            var taskId = runResponse.taskId;
            var statusBody = {
              'accessToken': accessToken,
              'taskId': taskId
            };
            var statusInterval = setInterval(async function () {
              var statusResponse = await sendRequest('status', url, statusBody);
              console.log(JSON.stringify(statusResponse));
              if (statusResponse.taskStatus == 'Success' || statusResponse.taskStatus == 'Failure') {
                clearInterval(statusInterval);
              }
            }, 5000); // 5sec
          }
        }
      }
    }
    kintone.app.record.getHeaderMenuSpaceElement().appendChild(runButton);
  });
})();
function sendRequest(api, url, body) {
  var _kintone = kintone;
  var uri = url + '/' + api;
  return new _kintone.Promise(function (resolve, reject) {
    _kintone.proxy(uri, 'POST', {
      'Content-Type': 'application/json;charset=UTF-8'
    }, body, function (body, status, headers) {
      resolve(JSON.parse(body));
    }, function (error) {
      reject(error);
    });
  });
}