ヘルプで見つからない情報は、サポートにお問い合わせください。お問い合わせ

開発者向け機能:API機能:テーブル操作:レコード更新

レコード更新APIの機能仕様です。
APIを使用してレコードを更新する事ができます。 

■事前準備
APIの操作を行う前にAPIキーの作成を実施してください。 

■URL
下記のURLを使用します。
{Id}は更新するレコードのIDに置換してください。
https://ks01.shelterdb.net/api/items/{Id}/update


■リクエスト(添付ファイルなし)
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Typeに'application/json'、文字コードはUTF-8を使用してください。
登録するデータのレイアウトはこちらを参照してください。
また、ClassやNum等の項目を設定する際は以下のように"{項目名}Hash"と記載してください。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX...",
    "Title": "新機能XXを開発する2",
    "Body":"ボディ2",
    "CompletionTime":"2018/3/31",
    "ClassHash": {
        "ClassA": "分類2",
        "ClassB": "未分類2",
        "ClassC": "その他2"
    },
    "NumHash": {
        "NumA": 100,
        "NumB": 200
    },
    "DateHash": {
        "DateA": "2019/01/01",
        "DateB": "2020/01/01"
    },
    "DescriptionHash": {
        "DescriptionA": "説明2",
        "DescriptionB": "概要2",
        "DescriptionC": "補足2"
    },
    "CheckHash": {
        "CheckA": false,
        "CheckB": true
    }      
}


■リクエスト(添付ファイルあり)
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Typeに'application/json'、文字コードはUTF-8を使用してください。
添付ファイルなしのjsonデータに下記のようなAttachmentsHashを追記してください。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX...",
    "Title": "新機能XXを開発する2",
    "Body":"ボディ2",
    "CompletionTime":"2018/3/31",
    "ClassHash": {
        "ClassA": "分類2",
        "ClassB": "未分類2",
        "ClassC": "その他2"
    },
    "NumHash": {
        "NumA": 100,
        "NumB": 200
    },
    "DateHash": {
        "DateA": "2019/01/01",
        "DateB": "2020/01/01"
    },
    "DescriptionHash": {
        "DescriptionA": "説明2",
        "DescriptionB": "概要2",
        "DescriptionC": "補足2"
    },
    "CheckHash": {
        "CheckA": false,
        "CheckB": true
    },
    "AttachmentsHash": {
        "AttachmentsA": [
            {
                "ContentType": "text/plain",
                "Name": "Readme.txt",
                "Base64": "4O5O4jjfui…"
            }
        ]
    }
}


■リクエスト(添付ファイル削除)
AttachmentsA内のGuidにはファイルのGUIDを指定してください。
また、AttachmentsA内のDeletedには1を指定してください。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX...",
    "AttachmentsHash": {
        "AttachmentsA": [
            {
                "Guid" : "7AB84732…",
                "Deleted" : 1
            }
        ]
    }
}


・Guidの取得方法
添付ファイルのあるレコードを以下のリンク先に従って取得します。
API機能:テーブル操作:単一レコード取得
取得したjsonファイルの"Attachments"項目に添付ファイルのGuidが記載されているのでその値を使用してください。


■レスポンス(添付ファイルあり、なし両方)
下記の形式のjsonデータが返却されます。

{
    "Id": 12345,
    "StatusCode": 200,
    "LimitPerDate": 10000,
    "LimitRemaining": 9994,
    "Message": "\" 新機能XXを開発する2 \" を更新しました。"
}

 ※"Message"内の\表記はバックスラッシュです。

  • はじめてご利用になる方へ
Powered by Zendesk