kintone-client.app — toyokumo/kintone-client 0.6.1

add-form-fields clj/s

(add-form-fields conn app fields {:keys [revision]})

Adds fields to a form of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

fields - The field settings. See API reference regarding field format. map

opts

:revision - Specify the revision number of the settings that will be deployed. integer

add-preview-app clj/s

(add-preview-app conn {:keys [name space thread]})

Creates a preview App. The deploy-app-settings must be used on the created preview App for the App to become live. API Tokens cannot be used with this API.

opts

:name - The App name. (Required) string

:space - The Space ID of where the App will be created. integer

:thread - The Thread ID of the thread in the Space where the App will be created. integer

delete-form-fields clj/s

(delete-form-fields conn app codes {:keys [revision]})

Deletes fields from a form of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

codes - The list of field codes of the fields to delete. Up to 100 field codes can be specified. sequence

opts

:revision - Specify the revision number of the settings that will be deployed. integer

deploy-app-settings clj/s

(deploy-app-settings conn apps {:keys [revert]})

Updates the settings of a pre-live App to the live App. API Tokens cannot be used with this API.

apps - The list of Apps to deploy the pre-live settings to the live Apps. sequence of integer

opts

:revert - Specify true to cancel all changes made to the pre-live settings. boolean

get-acl clj/s

(get-acl conn app {:keys [preview?]})

Gets the App permissions of an app. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:preview? - Gets from pre-live settings. boolean

get-app clj/s

(get-app conn app)

Gets general information of an App, including the name, description, related Space, creator and updater information.

app - The kintone app ID. integer

get-app-deploy-status clj/s

(get-app-deploy-status conn apps)

Gets the deployment status of the App settings for multiple Apps. API Tokens cannot be used with this API.

apps - Sequence of kintone app ID. sequence of integer

get-apps clj/s

(get-apps conn {:keys [offset limit codes name ids space-ids]})

Gets general information of multiple Apps, including the name, description, related Space, creator and updater information.

opts

:offset - The number of retrievals that will be skipped. The default value is 0 if this is not assigned. integer

:limit - The number of Apps to retrieve. The default value is 100 if this is not assigned. integer

:codes - The App Code. sequence of string

:name - The App Name. string

:ids - The App IDs. sequence of integer

:space-ids - The space id where the app resides. sequence of integer

get-customize clj/s

(get-customize conn app {:keys [preview?]})

Gets the JavaScript and CSS Customization settings of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:preview? - Gets from pre-live settings. boolean

get-field-acl clj/s

(get-field-acl conn app {:keys [preview?]})

Gets the Field permission settings of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:preview? - Gets from pre-live settings. boolean

get-form clj/s

(get-form conn app)

Retrieves the form details of an app. WARN: This API is being deprecated. c.f. https://developer.kintone.io/hc/en-us/articles/213148927

app - The kintone app ID. integer

get-form-fields clj/s

(get-form-fields conn app {:keys [lang preview?]})

Gets the list of fields and field settings of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:lang - The localized language to retrieve the data. Support: default: default name ja: Japanese zh: Chinese en: English user: the language setting set on the user used for the authentication The default value is default if this is not assigned. string

:preview? - Gets from pre-live settings. boolean

get-form-layout clj/s

(get-form-layout conn app {:keys [preview?]})

Gets form layout of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:preview? - Gets from pre-live settings.

get-general-settings clj/s

(get-general-settings conn app {:keys [lang preview?]})

Gets the description, name, icon, revision and color theme of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:lang - The localized language to retrieve the data. Support: default: default name ja: Japanese zh: Chinese en: English user: the language setting set on the user used for the authentication The default value is default if this is not assigned. string

:preview? - Gets from pre-live settings. boolean

get-status clj/s

(get-status conn app {:keys [lang preview?]})

Gets the process management settings of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:lang - The localized language to retrieve the data. Support: default: default name ja: Japanese zh: Chinese en: English user: the language setting set on the user used for the authentication The default value is default if this is not assigned. string

:preview? - Gets from pre-live settings. boolean

get-views clj/s

(get-views conn app {:keys [lang preview?]})

Gets the View settings of an App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

opts

:lang - The localized language to retrieve the data. Support: default: default name ja: Japanese zh: Chinese en: English user: the language setting set on the user used for the authentication The default value is default if this is not assigned. string

:preview? - Gets from pre-live settings. boolean

update-acl clj/s

(update-acl conn app rights {:keys [revision]})

Updates the App permissions of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID.

rights - The permission settings. See API reference regarding permission format. sequence of map

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-customize clj/s

(update-customize conn app customize {:keys [revision]})

Updates the JavaScript and CSS Customization settings of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

customize - Customize setting. See API reference regarding customize format. map

:desktop - The setting of JavaScript and CSS files for the desktop. map

:mobile - The setting of JavaScript and CSS files for the desktop. map

:scope - The scope of customization. string

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-field-acl clj/s

(update-field-acl conn app rights {:keys [revision]})

Updates the Field permission settings of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID.

rights - The field permission settings. See API reference regarding field permission format. sequence of map

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-form-fields clj/s

(update-form-fields conn app fields {:keys [revision]})

Updates the field settings of fields in a form of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID. integer

fields - The field settings. See API reference regarding record format. map

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-form-layout clj/s

(update-form-layout conn app layout {:keys [revision]})

Updates the field layout info of a form in an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID integer

layout - A list of field layouts for each row. See API reference regarding form layout format. sequence of map

update-general-settings clj/s

(update-general-settings conn app settings {:keys [revision]})

Updates the description, name, icon, revision and color theme of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID.

settings - The general settings. Parameters that are ignored will not be updated. See API reference regarding general settings format. map

:name - The App name. string

:icon - The app icon. map

:type - The icon type. "FILE" or "PRESET"
        string

:key - The key identifier of the icon.
       string

:file - The key identifier of the icon.
        map

  :fileKey - The file key of the icon.
             string

:theme - The Color theme.

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-live-field-acl clj/s

(update-live-field-acl conn app rights {:keys [revision]})

Updates the Field permission settings of LIVE ENVIRONMENT an App. API Tokens cannot be used with this API.

app - The kintone app ID.

rights - The field permission settings. See API reference regarding field permission format. sequence of map

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-status clj/s

(update-status conn app status {:keys [revision]})

Updates the process management settings of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone App ID.

status - The process management setting. See API reference regarding process management format. map

:enable - The on/off settings of the process management settings. string

:states - The process management statuses. map

:actions - The actions. sequence of map

opts

:revision - Specify the revision number of the settings that will be deployed. integer

update-views clj/s

(update-views conn app views {:keys [revision]})

Updates the View settings of an App. After using this API, use the deploy-app-settings to deploy the settings to the live App. API Tokens cannot be used with this API.

app - The kintone app ID.

views - The view settings. See API reference regarding record format. map

opts

:revision - Specify the revision number of the settings that will be deployed. integer