開発者向け機能：API機能：添付ファイル操作：ファイル取得 – Shelter

添付ファイルを取得するAPIの機能仕様です。
APIを使用してユーザーのレコードを取得する事ができます。

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

■URL
下記のURLを使用します。
https://ks01.shelterdb.net/api/binaries/{Guid}/get

■Guidの取得方法
添付ファイルのあるレコードを以下のリンク先に従って取得します。
API機能：テーブル操作：単一レコード取得

取得したjsonファイルの"Attachments"項目に添付ファイルのGuidが記載されているのでその値を使用してください。

■リクエスト
HTTP POSTで下記の形式のjsonデータを送信してください。
Content-Type は'application/json'、文字コードはUTF-8を使用してください。

{
    "ApiVersion": 1.1,
    "ApiKey": "XXXXXXXXXX..."
}

■レスポンス

{
    "Id": 28,
    "StatusCode": 200,
    "Message": "{ファイル名}を取得しました。",
    "Response": {
        "ReferenceId": xx,
        "BinaryType": "Attachments",
        "Base64": "dGVzdA==…",
        "Guid": "5E23245…",
        "FileName": "{ファイル名}",
        "Extension": ".txt",
        "Size": 54,
        "ContentType": "text/plain",
        "Creator": 1,
        "Updator": 1,
        "CreatedTime": "20xx/xx/xx xx:xx:xx",
        "UpdatedTime": "20xx/xx/xx xx:xx:xx"
    }
}

・Idには取得したBinariesテーブルのレコードのIDが格納されます。
・StatusCodeには完了時のステータスコードが格納されます。正常終了時は200です。
・Messageには完了時のメッセージが格納されます。
・ReferenceIdにはファイルが紐づいているレコードのIDが格納されます。
・BinaryTypeには添付ファイルの場合Attachments、画像の場合Imagesが格納されます。
・Base64にはBase64にエンコードされたファイルの内容が格納されます。
・GuidにはファイルのGUIDが格納されます。
・FileNameにはファイル名が格納されます。
・Extensionには拡張子が格納されます。
・Sizeにはファイルサイズがバイト単位で格納されます。
・ContentTypeにはファイルのMimeTypeが格納されます。
・Creatorにはファイル作成者のユーザIDが格納されます。
・Updatorにはファイル更新者のユーザIDが格納されます。
・CreatedTimeにはファイル作成日時が格納されます。
・UpdatedTimeにはファイル更新日時が格納されます。