Update Status

Updates the Status of a record of an App, that was set with the Process Management feature. (External link)

MethodPUT
URLhttps://{subdomain}.kintone.com/k/v1/record/status.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/record/status.json
Authentication Password Authentication, API Token Authentication, Session Authentication
Content-Typeapplication/json

Contents

Permissions

For Password Authentication, the user must have permission to view the record. Also, one of the following conditions must be met:

  1. The user is the Assignee of the record
  2. There are no Assignees set for the record

For API Token Authentication, the API Token must have permission to view the record. Also, one of the following conditions must be met:

  1. The user "Administrator" is the Assignee of the record
  2. There are no Assignees set for the record

Request Parameters

PARAMETER VALUE REQUIRED DESCRIPTION
action String Yes The Action name of the action to run.

If the localization feature has been used to apply multiple translations of the Action name, specify the name of the Action in the language settings of the user that will run the API. API Tokens follow the language settings set in the Localization page (External link) of the User & System Administration settings.
app Integer Yes The App ID.
assignee String Conditionally required The next Assignee. Specify the Assignee's log in name.

Required, if the "Assignee List" of the current status is set to "User chooses one assignee from the list to take action", and a selectable assignee exists.
id Integer Yes The record ID.
revision Integer Optional The revision number of the record before updating the status.
If the specified revision is not the latest revision, the request will result in an error.
The revision will not be checked if this parameter is ignored, or -1 is specified.

Sample Request

JavaScript (using Kintone REST API Request)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
var body = {
  'app': 1,
  'id': 3,
  'action': 'Start',
  'assignee': 'Krispy',
};

kintone.api(kintone.api.url('/k/v1/record/status.json', true), 'PUT', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

curl Sample

1
2
3
4
5
6
7
8
9
curl -X PUT 'https://{subdomain}.kintone.com/k/v1/record/status.json' \
-H 'X-Cybozu-API-Token: L08xCvTh7A1EVm3rZimF98R8VLP3k4lMlzELqyCx' \
-H 'Content-Type: application/json' \
-d '{
  "app": 1,
  "id": 3,
  "action": "start",
  "assignee": "Krispy"
}'

Response Parameters

PARAMETER VALUE DESCRIPTION
revision String The revision number of the record after updating the status.
The revision number will increase by 2, as two operations are preformed - running the action, and updating the status.

Sample Response

1
2
3
{
  "revision": "3"
}

Limitations

  • This API can only be used with Apps that have the Process Management feature enabled.