1つのレコードのステータスを更新する
レコードのステータスを更新します。
- プロセス管理機能を有効にしたアプリで使用できます。
- 1つのレコードのステータスを変更する場合と、複数のレコードのステータスを一括更新する場合とで、使用するAPIは異なります。
URI
https://(サブドメイン名).cybozu.com/k/v1/record/status.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/record/status.json
HTTPメソッド
PUT
必要なアクセス権
ユーザー認証でAPIを実行する場合
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
- レコードに作業者が指定されていない、または、APIの実行ユーザーがレコードの作業者に指定されている
APIトークンでAPIを実行する場合
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
- レコードに作業者が指定されていない、または、「Administrator」ユーザーがレコードの作業者に指定されている
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
action | 文字列 | 必須 | 実行するアクションの名前を指定します。 複数の言語でアクションの名前を設定している場合、APIの実行ユーザーに設定した表示言語での名前を指定します。 ※現在のステータスに同名のアクションが複数設定されている場合、そのアクションを指定するとエラーとなります。 |
app | 数値又は文字列 | 必須 | アプリのIDを指定します。 |
assignee | 文字列 |
条件 |
次の条件下では必須となり、ユーザーをログイン名で指定します。
|
id | 数値又は文字列 | 必須 | レコードのIDを指定します。 |
revision | 数値又は文字列 | ステータスを変更する前の、レコードのリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。 指定を省略、または「-1」を指定すると、リビジョンはチェックされません。 |
リクエストの例
ヘッダ
PUT /k/v1/record/status.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンス
パラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
revision | 文字列 | ステータスを変更したあとのレコードのリビジョン番号です。アクションの実行と、ステータスの更新の2つの操作が記録されるため、リビジョンは2つ増えます。 |
レスポンスの例
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
複数のレコードのステータスを一括更新する
URI
https://(サブドメイン名).cybozu.com/k/v1/records/status.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/records/status.json
HTTPメソッド
PUT
必要なアクセス権
ユーザー認証でAPIを実行する場合
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
- レコードに作業者が指定されていない、または、APIの実行ユーザーがレコードの作業者に指定されている
APIトークンでAPIを実行する場合
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
- レコードに作業者が指定されていない、または、「Administrator」がレコードの作業者に指定されている
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
app | 数値又は文字列 | 必須 | アプリのIDを指定します。 |
records | 配列 | 必須 | ステータスを更新するレコードを表す配列です。1度に100件まで指定できます。 |
records[].action | 文字列 | 必須 | 実行するアクションの名前を指定します。 複数の言語でアクションの名前を設定している場合、APIの実行ユーザーに設定した表示言語での名前を指定します。 ※現在のステータスに同名のアクションが複数設定されている場合、そのアクションを指定するとエラーとなります。 |
records[].assignee | 文字列 |
条件 |
次の条件下では必須となり、ユーザーをログイン名で指定します。
|
records[].id | 数値又は文字列 | 必須 | レコードのIDを指定します。 |
records[].revision | 数値又は文字列 | ステータスを変更する前の、レコードのリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。 指定を省略、または「-1」を指定すると、リビジョンはチェックされません。 |
リクエストの例
ヘッダ
PUT /k/v1/records/status.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンス
パラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
records | 配列 | ステータスを更新したレコードの情報を表す配列です。 |
records[].id | 文字列 | レコードのIDです。 |
records[].revision | 文字列 | ステータスを変更したあとのレコードのリビジョン番号です。アクションの実行と、ステータスの更新の2つの操作が記録されるため、リビジョンは2つ増えます。 |
レスポンスの例
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
関連
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。