Get Process Management Settings

Last Updated:
Follow
Gets the process management settings of an App.
Method GET
URL https://{subdomain}.kintone.com/k/v1/app/status.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/status.json
Authentication Password Authentication
Content-Type  

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/status.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/status.json

Permissions

  • Permission to view records are needed when obtaining information of live Apps.
  • App Management Permissions are needed when obtaining information of pre-live settings.
  • API Tokens cannot be used with this API.

Request Parameters

Parameter Value 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 REST API Request)

XMLHttpRequest

Response Parameters

Parameter Type Description
enable Boolean The on/off settings of the process management settings.
  • true： The process management settings is enabled.
  • false： The process management settings is disabled.
states Object An object containing data of the process management statuses.
null is returned for Apps that have never enabled the process management settings before.
states.{status_name}.name String The status name.
states.{status_name}.index String The display order (ascending) of the Status, when listed with the other statuses.
states.{status_name}.assignee Object An object containing data of the Assignee settings.
states.{status_name}.assignee.type String

The Assignee List type of the Status.

  • ONE : User chooses one assignee from the list to take action
  • ALL : All assignees in the list must take action
  • ANY : One assignee in the list must take action
The status with the lowest index will always return ONE.
states.{status_name}.assignee.entities Array An array listing data of the Assignees. They are listed in the same order as in the GUI.
states.{status_name}.assignee.entities[].entity Object An object containing user data of the Assignees.
Inactive users, deleted users/departments/groups and deleted Custom Fields will not be included in the response.
states.{status_name}.assignee.entities[].entity.type String The entity type of the Assignee.
  • USER : User
  • GROUP : Group
  • ORGANIZATION : Department
  • FIELD_ENTITY : User/Group/Department selection field
  • CREATOR : Created by field
  • CUSTOM_FIELD : Custom Field
states.{status_name}.assignee.entities[].entity.code

String

 

The code of the Assignee.
The following entities will return the following values:

  • FIELD_ENTITY : The field code of the field
  • CREATOR : null
  • CUSTOM_FIELD : The field code of the Custom Field
To specify guest space users, add the string "guest/" before the guest's log in name.
states.{status_name}.assignee.entities[].includeSubs Boolean The "Include affiliated departments" settings of the department.
  • true: Affiliated departments are included as Assignees
  • false: Affiliated departments are not included as Assignees
actions Array An array containing data of the Actions. They are listed in the same order as in the GUI.
null is returned for Apps that have never enabled the process management settings before.
actions[].name String The Action name.
actions[].from String The status before taking action.
actions[].to String The status after taking action.
actions[].filterCond String The branch criteria of the action.
revision String  The revision number of the App settings.

Sample Response

Was this article helpful?
0 out of 0 found this helpful
Do you have any questions or issues related to this article?
Please share your views with us in the Community forums!