API Docs

Get Required Plug-ins

Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps.
This can occur when a plug-in is installed, added to an App, and then proceeded to be uninstalled from the Kintone environment.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/plugins/required.json
Authentication Password Authentication , Session Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Permissions

  • No permissions are needed.

Request Parameters

Parameter Value Required Description
offset Integer The number of plug-ins to skip from the list of required plug-ins.
If ignored, this value is 0.
limit Integer The maximum number of plug-ins to retrieve.
Must be between 1 and 100.
The default number is 100.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'offset': 1,
  'limit': 3
};
kintone.api(kintone.api.url('/k/v1/plugins/required.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

curl Sample 

1
2
3
4
5
6

curl -X GET 'https://{subdomain}.kintone.com/k/v1/plugins/required.json' \
  -H 'X-Cybozu-Authorization:{AuthorizationCode}' \
  -H 'Content-Type: application/json' \
  -d '{
    "offset": 1, "limit": 3
  }'

Response Parameters

Parameter Type Description
plugins Array of Objects A list of Plug-ins that needs to be installed.
plugins[].id String The Plugin ID.
plugins[].name String The name of the Plugin.
plugins[].isMarketPlugin Boolean States whether or not the plug-in is a Marketplace plug-in.
  • true: The plug-in is a Marketplace plug-in.
  • false: The plug-in is not a Marketplace plug-in.

Sample Response 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

{
    "plugins": [
        {
          "id": "djmhffjhfgmebgnmcggopedaofckljlj",
          "name":"Plugin 1",
          "isMarketPlugin": false,
        },
        {
          "id":"ejgcopfamifdhmkafjgidfmgjdmiaplf",
          "name":"Plugin 2",
          "isMarketPlugin":false,
        },
        {
          "id":"fdeplpmkengkldpdlaiegpokgmaabkkb",
          "name":"Plugin 3",
          "isMarketPlugin":false,
          }
    ]
}