Box Developerドキュメント
最新バージョン

フォルダに電子すかしを適用

put
https://api.box.com/2.0
/folders/:folder_id/watermark

フォルダの電子すかしを適用または更新します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_id123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

リクエスト本文

object本文内

フォルダに適用する電子すかし

string本文内必須
"default"

適用する電子すかしのタイプ。

現在サポートされているオプションは1つのみです。

次の値に固定: default

レスポンス

application/jsonWatermark

このフォルダに電子すかしがすでに適用されている場合は、更新された電子すかしを返します。

application/jsonWatermark

このフォルダにまだ電子すかしが適用されていない場合は、新しい電子すかしを返します。

予期しないクライアントエラー。

put
フォルダに電子すかしを適用
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X PUT "https://api.box.com/2.0/folders/4353455/watermark" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "watermark": {
         "imprint": "default"
       }
     }'
TypeScript Gen
await client.folderWatermarks.updateFolderWatermark(folder.id, {
  watermark: new UpdateFolderWatermarkRequestBodyWatermarkField({
    imprint: 'default' as UpdateFolderWatermarkRequestBodyWatermarkImprintField,
  }),
} satisfies UpdateFolderWatermarkRequestBody);
Python Gen
client.folder_watermarks.update_folder_watermark(
    folder.id,
    UpdateFolderWatermarkWatermark(
        imprint=UpdateFolderWatermarkWatermarkImprintField.DEFAULT
    ),
)
.NET Gen
await client.FolderWatermarks.UpdateFolderWatermarkAsync(folderId: folder.Id, requestBody: new UpdateFolderWatermarkRequestBody(watermark: new UpdateFolderWatermarkRequestBodyWatermarkField(imprint: UpdateFolderWatermarkRequestBodyWatermarkImprintField.Default)));
Java
BoxFolder folder = new BoxFolder(api, id);
fodler.applyWatermark();
Python
watermark = client.folder(folder_id='11111').apply_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}')
.NET
BoxWatermark watermark = await client.FoldersManager.ApplyWatermarkAsync("22222");
Node
client.folders.applyWatermark('22222')
	.then(watermark => {
		/* watermark -> {
			watermark: 
			{ created_at: '2016-10-31T15:33:33-07:00',
				modified_at: '2016-10-31T15:33:33-07:00' } }
		*/
	});

レスポンスの例

{
  "watermark": {
    "created_at": "2012-12-12T10:53:43-08:00",
    "modified_at": "2012-12-12T10:53:43-08:00"
  }
}