レコード更新APIの機能仕様です。
APIを使用してレコードを更新する事ができます。 レコードの内容の変更に加え、添付ファイルの追加、削除やレコードのアクセス制御の変更が可能です。
■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。
■制限事項
対象の「レコード」に「更新」権限が必要です。
レコードのアクセス制御を変更するには「権限の管理」権限が必要です。
■リクエスト
下記のリクエスト形式で、jsonデータを送信します。
＜設定項目＞
| 設定項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| Content-Type | application/json |
| 文字コード | UTF-8 |
| URL | https://ks01.shelterdb.net/api/items/{Id}/update {Id}は更新するレコードのIDに置換してください。 |
| Body | 以下のjsonデータを参考のこと |
APIによる画像の挿入について
BodyにImageHashを指定することで「内容」「コメント」「説明」項目に画像を挿入することが可能です。 更新系のAPI（update／upsert）で本機能によるレコード更新を行う場合、既存レコードの該当項目は「内容」「説明」項目では上書き、「コメント」項目では追加となります。また、更新系のAPIで「内容」「説明」項目に登録する文字列を指定するBodyやDescriptionHashを省略した状態でImageHashのみを指定すると、上書きではなく追加となります。
＜ImageHashの指定方法＞
| 第1階層 | 第2階層 | 第3階層 | 説明 | 例 |
|---|---|---|---|---|
| ImageHash | Body | HeadNewLine | 画像を挿入する際の先頭の改行有無をtrue/falseで指定します。省略した場合は改行無しになります。 | true |
| EndNewLine | 画像を挿入する際の末尾の改行有無をtrue/falseで指定します。省略した場合は改行無しになります。 | true | ||
| Position | 同じリクエスト内で対象項目に文字列を設定する場合に画像を何文字目に挿入するかを数値で指定します。-1を指定した場合および省略した場合は末尾に挿入されます。 | 3 | ||
| Alt | alt属性（Webブラウザで画像が表示できないときに、画像の代わりに表示されるテキスト）に挿入する文字列を指定します。省略した場合は「image」が設定されます。 | shelter | ||
| Extension | Binariesテーブルに登録するファイル拡張子を指定します。省略した場合は「.png」が設定されます。 | .jpeg | ||
| Base64 | Base64エンコードした画像のバイナリデータを文字列で指定します。ImageHashを指定する場合、省略はできません。 | iVBORw0KG…（以下略） | ||
| Comments | （同上） | （同上） | - | |
| DescriptionA | （同上） | （同上） | - | |
| DescriptionB | （同上） | （同上） | - |
APIによるプロセスの実行について
リクエストデータに、プロセスIDを指定し、プロセスを実行することが可能です。
■事前準備
事前に「プロセス」を設定してください。
■制限事項
APIからプロセスを実行する場合、プロセスで設定した入力検証は適用されません。
＜プロセスの指定方法＞
ProccessId または ProccessIds のいずれか一方を設定してください。
両方が設定された場合は、ProccessIds が有効となります。
ProccessIds を指定した場合、リストで指定された複数のプロセスIDは、事前に設定されているプロセス一覧の表示順に従って実行されます。
| 設定項目 | 説明 | 例 |
|---|---|---|
| ProccessId | プロセスのIDを指定します。 | 1 |
| ProccessIds | 複数のプロセスのIDを指定します。 | [1,2,3] |
■リクエスト
(a)通常の更新
ClassやNum等の項目を設定する際は以下のように"{項目名}Hash"と記載してください。
{
"ApiVersion": 1.1,
"ApiKey": "ad7816s5sD2safFafaD...",
"Title": "新機能XXを開発する2",
"Body": "ボディ2",
"CompletionTime": "2025/3/31",
"ProcessId": 1,
"ClassHash": {
"ClassA": "分類2",
"ClassB": "未分類2",
"ClassC": "その他2"
},
"NumHash": {
"NumA": 100,
"NumB": 200
},
"DateHash": {
"DateA": "2026/01/01",
"DateB": "2026/01/01"
},
"DescriptionHash": {
"DescriptionA": "説明2",
"DescriptionB": "概要2",
"DescriptionC": "補足2"
},
"CheckHash": {
"CheckA": false,
"CheckB": true
},
"AttachmentsHash": {
"AttachmentsA": [
{
"ContentType": "text/plain",
"Name": "Readme.txt",
"Base64": "4O5O4jjfui..."
}
]
},
"ImageHash": {
"Body": {
"HeadNewLine": true,
"EndNewLine": true,
"Position": 3,
"Alt": "imageBody",
"Extension": ".jpeg",
"Base64": "iVBORw0KG…"
},
"DescriptionA": {
"HeadNewLine": true,
"EndNewLine": true,
"Position": 3,
"Alt": "imageDescriptionA",
"Extension": ".jpeg",
"Base64": "iVBORw0KG..."
}
}
}
(b)添付ファイル削除
AttachmentsA内のGuidにはファイルのGUIDを指定してください。
添付ファイルを削除する場合、GUIDの指定は必ず大文字で記載してください。
また、AttachmentsA内のDeletedには1を指定してください。
{
"ApiVersion": 1.1,
"ApiKey": "2bcb8a909da1d8827c99c...",
"AttachmentsHash": {
"AttachmentsA": [
{
"Guid": "7AB84732...",
"Deleted": 1
}
]
}
}
添付ファイルのGuidの取得方法
添付ファイルのあるレコードを以下のリンク先に従って取得します。
API機能：テーブル操作：単一レコード取得
取得したjsonファイルの"Attachments"項目に添付ファイルのGuidが記載されているのでその値を使用してください。
(c)レコードのアクセス制御の設定
レコードのアクセス制御を変更するにはRecordPermissionsを指定します。「権限の管理」権限を持ったApiKeyを指定する必要があります。下記の例では、組織ID:1に書き込み権限、グループID:1に管理権限、ユーザID:10に読み取り権限を付与しています。レコードのアクセス制御を指定すると、既存の設定を削除し、指定したものに置き換えます。追加や一部を削除することはできません。
{
"ApiVersion": 1.1,
"ApiKey": "2bcb8a909da1d8827c99c...",
"RecordPermissions": [
"Dept,1,31",
"Group,1,511",
"User,10,1"
]
}
権限の種類
権限の種類は下記のとおりです。与える権限の値の合計値を計算し設定してください。例えば読取りと作成と更新を与えるには、1+2+4で7とします。すべての権限を与えるには511とします。
| 種類 | 値 |
|---|---|
| 読取り | 1 |
| 作成 | 2 |
| 更新 | 4 |
| 削除 | 8 |
| メール送信 | 16 |
| エクスポート | 32 |
| インポート | 64 |
| サイトの管理 | 128 |
| 権限の管理 | 256 |
■レスポンス
下記の形式のjsonデータが返却されます。
{
"Id": 12345,
"StatusCode": 200,
"LimitPerDate": 10000,
"LimitRemaining": 9994,
"Message": "\" 新機能XXを開発する2 \" を更新しました。"
}