Box Developerドキュメント

ファイルに電子すかしを適用

put
https://api.box.com/2.0
/files/:file_id/watermark

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ファイルを表す一意の識別子。

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

リクエスト本文

object本文内

ファイルに適用する電子すかし

string本文内必須
"default"

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

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

次の値に固定: default

レスポンス

application/jsonWatermark

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

application/jsonWatermark

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

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

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

リクエストの例

cURL
curl -i -X PUT "https://api.box.com/2.0/files/12345/watermark" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "watermark": {
         "imprint": "default"
       }
     }'
TypeScript Gen
await client.fileWatermarks.updateFileWatermark(file.id, {
  watermark: new UpdateFileWatermarkRequestBodyWatermarkField({
    imprint: 'default' as UpdateFileWatermarkRequestBodyWatermarkImprintField,
  }),
} satisfies UpdateFileWatermarkRequestBody);
Python Gen
client.file_watermarks.update_file_watermark(
    file.id,
    UpdateFileWatermarkWatermark(
        imprint=UpdateFileWatermarkWatermarkImprintField.DEFAULT.value
    ),
)
.NET Gen
await client.FileWatermarks.UpdateFileWatermarkAsync(fileId: file.Id, requestBody: new UpdateFileWatermarkRequestBody(watermark: new UpdateFileWatermarkRequestBodyWatermarkField(imprint: UpdateFileWatermarkRequestBodyWatermarkImprintField.Default)));
Java
BoxFile file = new BoxFile(api, id);
file.applyWatermark();
Python
watermark = client.file(file_id='12345').apply_watermark()
print(f'Watermark created at {watermark.created_at} and modified at {watermark.modified_at}')
.NET
BoxWatermark watermark = await client.FilesManager.ApplyWatermarkAsync("11111");
Node
client.files.applyWatermark('11111')
	.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"
  }
}