Get Action Settings

API Docs

Get Action Settings

Gets the Action Settings of the App. For more information on Actions, refer to the following article:
Configuring App Actions

Method	GET
URL	https://{subdomain}.kintone.com/k/v1/app/actions.json
URL(guest space)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/actions.json
Authentication	Password Authentication , API Token Authentication , Session Authentication
Content-Type	application/json (not needed if specifying the query with a query string)

Pre-live Settings
Permissions
Request Parameters
Sample Request
Response Parameters
Sample Response
Limitations
Notes

Pre-live Settings

Apps may hold pre-live settings that have not yet been deployed to the live App.
Access the pre-live settings with the below URL.

URL	https://{subdomain}.kintone.com/k/v1/preview/app/actions.json
URL(guest space)	https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/actions.json

Permissions

App Management Permissions are needed.

Request Parameters

Parameter	Type	Required	Description
app	Integer or String	Yes	The App ID.
lang	String		The localized language to retrieve the data in: `default`: retrieves the default names `en`: retrieves the localized English names `zh`: retrieves the localized Chinese names `ja`: retrieves the localized Japanese names `user`: retrieves the localized names in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved.

* If the user language setting is set to Use Web browser settings, the settings set in the Accept-Language header will be used. If there is no Accept-Language header, the language set in the Localization settings in the System Administrator's menu will be used.

Sample Request

JavaScript Using kintone.api()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


var body = {
  'app': kintone.app.getId(),
  'lang': 'en'
};

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

curl Sample

1
2
3
4
5
6
7
8


$ curl -X GET \
  https://{subdomain}.kintone.com/v1/app/actions.json \
  -H 'Content-Type: application/json' \
  -H 'X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=' \
  -d '{
        "app": 1,
        "lang": "en"
      }'

Response Parameters

Parameter	Type	Description
actions	Object	An object of Action settings. The object's key is the Action's unique identifier, which is set as the Action's name in its default language settings (this is regardless of the lang request parameter's value). The values of the key are the various Action settings associated with that Action.
actions.{actionname}.name	String	The name of the Action. When the lang request parameter is specified, the Action's name in that language will be returned.
actions.{actionname}.id	String	The ID of the Action.
actions.{actionname}.index	String	The order of the Action, starting from 0.
actions.{actionname}.destApp	Object	An object containing the Target option that specifies the destination app where data is to be copied.
actions.{actionname}.destApp.app	String	The App ID of the copy destination app.
actions.{actionname}.destApp.code	String	The App Code of the copy destination app. An empty string is returned if an App Code is not set in the destination app's settings.
actions.{actionname}.mappings	Array	An array of objects containing the Field Mappings options. An empty array is returned if the Field Mappings options are not configured.
actions.{actionname}.mappings[].srcType	String	The type of source data that is to be copied. `FIELD`: Data stored in the source app's field `RECORD_URL`: The Record's permalink
actions.{actionname}.mappings[].srcField	String	The field code of the field specified in the Field Mappings options as the source. This parameter is returned only if the `actions.{actionname}.mappings[].srcType` parameter is set to `FIELD`.
actions.{actionname}.mappings[].destField	String	The field code of the field specified in the Field Mappings options as the destination.
actions.{actionname}.entities	Array	An array of objects containing the entities the `Action` is granted to. This reflects the Available To options. Inactive users and deleted users/departments/groups will not be included in the response.
actions.{actionname}.entities[].type	String	The type of the entity the Action is granted to. `USER`: User `GROUP`: Group `ORGANIZATION`: Department
actions.{actionname}.entities[].code	String	The code of the entity the Action is granted to. For guest users, the login name is preceded by guest/.
actions.{actionname}.filterCond	String	The condition to run the Action. If an empty string is specified, the Action will be run on All records. Deleted or inactive User/Group/Department cannot be specified. For more information on query string, refer to the following article: Query string
revision	String	The revision number of the App settings.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32


{
  "actions": {
    "Action_A": {
      "name": "Action_A",
      "id": "1",
      "index": "0",
      "destApp": {
        "app": "2",
        "code": "INVOICE"
      },
      "mappings": [
        {
          "srcType": "FIELD",
          "srcField": "CompanyName",
          "destField": "CompanyName"
        },
        {
          "srcType": "RECORD_URL",
          "destField": "URL"
        }
      ],
      "entities": [
        {
          "type": "USER",
          "code": "userA"
        }
      ],
      "filterCond": "User_selection in (\"user1\")"
    }
  },
  "revision": "2"
}

Limitations

If multiple Actions have the same name within the same App, this API will return an error.

Notes

Even though the Disable this feature: Ability to Set Conditions for When App Actions Can Be Used option is checked, it will still be included in the following API's response.
Get API Schema

API Docs