カスタム・レンディションの削除
/documents/api/1.2/files/{fileId}/data/rendition
指定されたカスタム・レンディションを削除します。
リクエスト
- application/json
- application/xml
- fileId: string
ファイルのグローバル一意識別子(GUID)。
- rendition: string
アップロードのカスタム・レンディションに指定されたレンディション
name
。 - version(optional): string
使用するファイルのバージョン番号を指定します。 バージョンが指定されていない場合は、最新バージョンが使用されます。 特定のファイル・バージョンに対してのみカスタム・レンディションが存在することに注意することが重要です。
- accessToken(optional): string
現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplinkアクセス・トークン。 このパラメータは、
appLinkID
が使用されている場合は必須です。 これはaccessTokenまたはAccessTokenとして使用できます。 - appLinkID(optional): string
現在のユーザーに親フォルダまたはこのファイルにアクセスすることを許可するApplink ID。 パラメータ
appLinkID
が使用されるときはいつでも、パラメータaccessToken
も提供されなければなりません。 働くには、このapplinkは、少なくともコントリビュータ・ロールが付与されていなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。 - dAccessCode(optional): string
保護されたパブリック・リンクを使用するために必要なアクセス・コード。 次の形式のCookieヘッダーの一部として送信する必要があります:
dAccessCode-<linkID>=<passcodeValue>
- linkID(optional): string
現在のユーザーにこのファイルへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。 linkIDまたはLinkIDとして使用できます。
レスポンス
- application/json
- application/xml
200レスポンス
リクエストが処理されました。
403レスポンス
ユーザーに読取り権限がない場合は禁止されています。
404レスポンス
ファイルIDまたはレンディションが見つかりません。
例
次の例では、small
という名前のカスタム・レンディションを、指定されたファイルの最新バージョンから削除します。
DELETE .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=small
リクエスト・ヘッダー
なし。
リクエスト本文
なし。
HTTPステータス・コード
HTTP_STATUS = 200
JSONレスポンス
{ "errorCode": "0", "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001", "type": "file" }
例2
次の例では、applinkRendition
という名前のカスタム・レンディションを、指定されたファイルの最新バージョンから削除します。 このファイルは現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplink IDを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。
DELETE .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/data/rendition?rendition=applinkRendition&version=2
リクエスト・ヘッダー
appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg== accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ
リクエスト本文
なし。
HTTPステータス・コード
HTTP_STATUS = 200
JSONレスポンス
{ "errorCode": "0", "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518", "type": "file" }