Updates the process management settings of an App.
After using this API, the Deploy App Settings API must be used for the settings to be deployed to the live App.
After using this API, the Deploy App Settings API must be used for the settings to be deployed to the live App.
| Method | PUT |
| 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 |
| Authentication | Password Authentication |
| Content-Type | application/json |
Permissions
- App Management Permissions are needed.
- API Tokens cannot be used with this API.
Request Parameters
Parameters that are ignored will not be updated.
| Parameter | Value | Required | Description |
|---|---|---|---|
| app | Integer or String | Yes | The App ID. |
| enable | Boolean or String |
The on/off settings of the process management settings.
|
|
| states | Object | An object containing data of the process management statuses. | |
| states.{status_name} | Object | An object containing the settings of each status. Specify the status before taking action, for {status_name}. If a status that does not exist is specified for {status_name}, it will be added as a new status. If an existing status is not specified for {status_name}, that status will be deleted. |
|
| states.{status_name}.name | String | Conditional | The status name. The maximum length is 64 characters. Required, if stating a new status for states.{status_name}. In this case, state the same value used for states.{status_name}. |
| states.{status_name}.index | Integer or String | Conditional | The display order (ascending from 0) 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 | Conditional |
The Assignee List type of the Status.
|
| states.{status_name}.assignee.entities | Array | Conditional |
An array listing data of the Assignees. |
| states.{status_name}.assignee.entities[].entity | Object | Conditional | An object containing user data of the Assignees. Required, if setting the entities parameter. |
| states.{status_name}.assignee.entities[].entity.type | String | Conditional |
The entity type of the Assignee.
Departments cannot be specified in guest space Apps. |
| states.{status_name}.assignee.entities[].entity.code | String | Conditional |
The code of the Assignee. If "FIELD_ENTITY" is specified for the entity.type, state the field code of the following fields:
If "CUSTOM_FIELD" is specified for entity.type, state the field code of the Custom Field
If "CREATOR" is specified for entity.type, ignore this parameter.
|
| states.{status_name}.assignee.entities[].includeSubs | Boolean or String |
The "Include affiliated departments" settings of the department.
If ignored, this value is false.
|
|
| actions | Array | An array containing data of the Actions. | |
| actions[].name | String | Conditional |
The Action name. |
| actions[].from | String | Conditional |
The Status name before taking action. |
| actions[].to | String | Conditional | The Status name after taking action. If a Status name that you want to specify has been changed, place the changed value for this parameter. Required, if setting the actions parameter. |
| actions[].filterCond | String |
The branch criteria of the action, specified as a query. |
|
| revision | Integer or String | Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. |
Sample Request
Response Parameters
| Parameter | Type | Description |
| revision | String | The revision number of the App settings. |