機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. Publiclinks

パブリック・リンク編集

put

/documents/api/1.2/publiclinks/{linkId}

使用可能なパブリック・リンク・パラメータを編集します。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • パブリック・リンクのグローバル一意識別子(GUID)。
本文 ()
リクエスト本文では、パブリック・リンク編集リクエストの詳細を定義します。 必須の属性はありません。
ルート・スキーマ: PublicLinkEditBody
タイプ: object
リクエスト本文では、パブリック・リンク編集リクエストの詳細を定義します。 必須の属性はありません。
ソースを表示

  • リンクを使用できるユーザーのグループ。

    • ユーザーのカンマ区切りリスト(ユーザーID、ログイン名または電子メール・アドレスのいずれか)
    • @serviceinstance: アカウントを持つユーザーがロールで指定された権限によってリソースにアクセスできます
    • @everybody: あらゆるユーザーがロールで指定された権限によってリソースにアクセスできます

  • パブリック・リンクが期限切れになる日時(yyyy-mm-ddThh:mm:ss形式)。 

    For example, 2017-01-01T00:00:01.

    有効期限を指定しない場合、ユーザーがリンクを削除するまでリンクは有効です。

  • パブリック・リンクのパスワード。 使用できるのは8文字以上50文字以下です。 パスワードを指定しない場合、パスワードなしでリンクを使用できます。
  • 使用可能な値: [ "viewer", "downloader", "contributor" ]

    共有アイテムへのアクセス・レベル

    ノート:

    デフォルトのロールはビューアですが、パブリック・リンクのデフォルト・ロールに対するAPIユーザーのプリファレンス設定は、このデフォルトを別の値でオーバーライドできます。 サービス・コールによってロールを明示的に設定するのが理想的です。

    管理者または所有者を除き、指定したユーザーに任意の標準ロールを付与できます。

    • ビューア: ビューアはファイルおよびフォルダを表示できますが、何かを変更することはできません。
    • ダウンローダ: ダウンローダはファイルをダウンロードし、自分のコンピュータに保存することもできます。
    • コントリビュータ: コントリビュータはファイルの変更、ファイルの更新、新規ファイルのアップロードおよびファイルの削除を行うこともできます。

リクエストの例(application/json)
{
    "assignedUsers":"@everybody",
    "expirationTime":"2016-02-15T01:02:03",
    "password":"password2",
    "role":"viewer"
}
トップに戻る

レスポンス

サポートされるメディア・タイプ

200レスポンス

リクエストが処理されました。

本文 ()
ルート・スキーマ: PublicLinkGetResponse
タイプ: object
レスポンス本文には、パブリック・リンクに関する情報が含まれます。
ソースを表示
すべてに一致
ソースを表示
ネストされたスキーマ: PublicLinkDefinition
タイプ: object
パブリック・リンク情報。
ソースを表示
ネストされたスキーマ: User
タイプ: object
ユーザー情報
ソースを表示
レスポンスの例(application/json)
{
    "linkID":"LFCE8A35C88A6A96FD39B621T0000000000100000001",
    "linkName":"pub-test-158",
    "assignedUsers":"@everybody",
    "role":"viewer",
    "type":"publiclink",
    "createdTime":"2015-06-05T21:04:56Z",
    "expirationTime":"2016-02-15T01:02:03Z",
    "lastModifiedTime":"2015-06-10T22:01:08Z",
    "ownedBy":{
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "displayName":"User AA",
        "type":"user"
    },
    "errorCode":"0"
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

403レスポンス

ユーザーに読取り権限がない場合は禁止されています。

404レスポンス

リンクIDが見つかりません。

トップに戻る

例

次の例は、指定したパブリック・リンクの使用可能なパラメータのすべてに対する値を割り当てます。

PUT .../publiclinks/LFCE8A35C88A6A96FD39B621T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "@everybody",
	"expirationTime": "2016-02-15T01:02:03",
	"password": "password2",
	"role": "viewer"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "assignedUsers": "@everybody",
    "createdTime": "2015-06-05T21:04:56Z",
    "errorCode": "0",
    "expirationTime": "2016-02-15T01:02:03Z",
    "lastModifiedTime": "2015-06-10T22:01:08Z",
    "linkID": "LFCE8A35C88A6A96FD39B621T0000000000100000001",
    "linkName": "pub-test-158",
    "ownedBy": {
	      "displayName": "User AA",
	      "loginName": "userAALoginName",
	      "id": "U0EAA20910FAF3052ACB79E4T00000000001",
	      "type": "user"
    },
    "role": "viewer",
    "type": "publiclink"
}

例2

次の例では、リクエスト本文のroleパラメータが無効であるため、指定されたパブリック・リンクを編集しません。 

PUT .../publiclinks/LFE30701FF7D3371DCD7F9E245B3E9DD64907CA0D19F

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "@everybody",
	"linkName": "MyPublicLink1",
	"role": "vieweronly"
}

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csUnableToEditSharedLink!csInvalidSharingRole,vieweronly",
    "errorMessage": "Failed to edit shared link. Invalid sharing role 'vieweronly'.",
    "errorType": "publiclink",
    "linkID": "LFE30701FF7D3371DCD7F9E245B3E9DD64907CA0D19F",
    "role": "vieweronly",
    "title": "Failed to edit shared link. Invalid sharing role 'vieweronly'.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例3

次の例では、リンクIDが無効であるため、指定されたパブリック・リンクは編集されません。

PUT .../publiclinks/LFE30701FF7D3371DCD7F9E245B3E9DD64907CA0D19F

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "@everybody",
	"linkName": "MyPublicLink1",
	"role": "downloader"
}

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "assignedUsers": "@everybody",
    "errorCode": "-16",
    "errorKey": "!csUnableToEditSharedLink!csUnableToFindLink",
    "errorMessage": "Failed to edit shared link. Unable to find the specified shared link.",
    "errorType": "publiclink",
    "linkID": "LFE30709FF7D3371DCD7F9E245B3E9DD64907CA0D19F",
    "role": "downloader",
    "title": "Failed to edit shared link. Unable to find the specified shared link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
先頭に戻る