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

フォルダ・パブリック・リンク作成

post

/documents/api/1.2/publiclinks/folder/{folderId}

指定したフォルダのパブリック・リンクを作成します。

公開リンクを使用すると、特定のユーザーが、アカウントを持っているかどうかに関係なく、リクエストされたフォルダにアクセスできます。

ノート:

パブリック・リンクを作成するには、リクエスタにそのフォルダまたはファイルに対する管理権限が必要です。 つまり、リクエスタは所有者であるか、管理者ロールが必要ということです。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
本文 ()
リクエスト本文では、パブリック・リンク作成リクエストの詳細を定義します。 Boldは必須の値を示します。
ルート・スキーマ: PublicLinkBody
タイプ: object
リクエスト本文では、パブリック・リンク作成リクエストの詳細を定義します。 Boldは必須の値を示します。
ソースを表示

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

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

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

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

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

  • パブリック・リンクの名前。 リンク名はオプションですが、リソースには名前のないパブリック・リンクを1つのみ持つことができます。
  • パブリック・リンクのパスワード。 使用できるのは8文字以上50文字以下です。 パスワードを指定しない場合、パスワードなしでリンクを使用できます。
  • 使用可能な値: [ "viewer", "downloader", "contributor" ]

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

    ノート:

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

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

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

リクエストの例(application/json)
{
    "assignedUsers":"@serviceinstance",
    "expirationTime":"2016-01-01T00:00:01Z",
    "password":"MyPassword",
    "linkName":"MyLinkOne",
    "role":"contributor"
}
トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: PublicLinkCreateResponse
タイプ: object
レスポンス本文には、新たに作成したパブリック・リンクに関する情報が含まれます。
ソースを表示
すべてに一致
ソースを表示
ネストされたスキーマ: PublicLinkDefinition
タイプ: object
パブリック・リンク情報。
ソースを表示
ネストされたスキーマ: User
タイプ: object
ユーザー情報
ソースを表示
レスポンスの例(application/json)
{
    "linkID":"LF906748A021ACD714CABC82T0000000000100000001",
    "linkName":"MyLinkOne",
    "assignedUsers":"@serviceinstance",
    "role":"contributor",
    "type":"publiclink",
    "createdTime":"2015-06-10T16:01:44Z",
    "expirationTime":"2016-01-01T00:00:01Z",
    "lastModifiedTime":"2015-06-10T16:01:44Z",
    "ownedBy":{
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "displayName":"User AA",
        "type":"user"
    },
    "errorCode":"0",
    "id":"FBE1117A270E747BB1D95024T0000000000100000001"
}

400レスポンス

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

403レスポンス

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

404レスポンス

フォルダIDが見つかりません。

トップに戻る

例

次の例は、コントリビュータ・レベルのアクセスを、指定したフォルダをホストするContent and Experienceインスタンスのすべてのアカウント保持者に付与します。

POST .../publiclinks/folder/FBE1117A270E747BB1D95024T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "@serviceinstance",
	"expirationTime": "2016-01-01T00:00:01Z",
	"password": "MyPassword",
	"linkName": "MyLinkOne",
	"role": "contributor"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "assignedUsers": "@everybody",
    "createdTime": "2015-06-10T16:01:44Z",
    "errorCode": "0",
    "expirationTime": "2016-01-01T00:00:01Z",
    "id": "FBE1117A270E747BB1D95024T0000000000100000001",
    "lastModifiedTime": "2015-06-10T16:01:44Z",
    "linkID": "LF906748A021ACD714CABC82T0000000000100000001",
    "linkName": "MyLinkOne",
    "ownedBy": {
	"displayName": "User AA",
	"loginName": "userAALoginName",
	"id": "U0EAA20910FAF3052ACB79E4T00000000001",
	"type": "user"
    },
    "role": "contributor",
    "type": "publiclink"
}

例2

次の例では、MyLinkDuplicateが指定されたフォルダIDに対してすでに作成されているため、パブリック・リンクは作成されません。 

POST .../publiclinks/folder/F42591255E9BED0FB76D1DC645B3E9DD6490E298CA02

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "@everybody",
	"linkName": "MyLinkDuplicate",
	"role": "viewer"
}

HTTPステータス・コード

HTTP_STATUS = 409

JSONレスポンス

{
    "errorCode": "-17",
    "errorKey": "!csUnableToCreateSharedLink!csLinkWithSameNameExists",
    "errorMessage": "Sorry, but we couldn't create a link to this content. Please try again later. Sorry, we cannot create a public link because there is already a link with that name. Make sure to use a unique name when creating a public link.",
    "errorType": "publiclink",
    "id": "F42591255E9BED0FB76D1DC645B3E9DD6490E298CA02",
    "linkName": "MyLinkDuplicate",
    "role": "viewer",
    "title": "Sorry, but we couldn't create a link to this content. Please try again later. Sorry, we cannot create a public link because there is already a link with that name. Make sure to use a unique name when creating a public link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例3

次の例では、必要なassignedUsersパラメータがリクエスト本文に存在しないため、パブリック・リンクは作成されません。 

POST .../publiclinks/folder/F42591255E9BED0FB76D1DC645B3E9DD6490E298CA02

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"linkName": "MyLink2",
	"role": "viewer"
}

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-97",
    "errorKey": "!csUnableToCreateSharedLink!csRequiredServiceParameterMissing,dAssignedUsers,CREATE_SHARED_LINK",
    "errorMessage": "Sorry, but we couldn't create a link to this content. Please try again later. Parameter 'dAssignedUsers' required by service CREATE_SHARED_LINK is missing.",
    "errorType": "publiclink",
    "id": "F42591255E9BED0FB76D1DC645B3E9DD6490E298CA02",
    "linkName": "MyLink2",
    "role": "viewer",
    "title": "Sorry, but we couldn't create a link to this content. Please try again later. Parameter 'dAssignedUsers' required by service CREATE_SHARED_LINK is missing.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、指定されたフォルダIDが存在しないため、パブリック・リンクは作成されません。

POST ...publiclinks/folder/F42551255E9BED0FB76D1DC645B3E9DD6490E298CA02

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "@everybody",
	"linkName": "MyLink4",
	"role": "viewer"
}

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "assignedUsers": "@everybody",
    "errorCode": "-16",
    "errorKey": "!csUnableToCreateSharedLink!csSecurityValidationFailed!csFldDoesNotExist,F42551255E9BED0FB76D1DC645B3E9DD6490E298CA02!csUnprivilegedSystemError",
    "errorMessage": "Sorry, but we couldn't create a link to this content. Please try again later. Security validation failed. 'F42551255E9BED0FB76D1DC645B3E9DD6490E298CA02' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "errorType": "publiclink",
    "id": "F42551255E9BED0FB76D1DC645B3E9DD6490E298CA02",
    "linkName": "MyLink4",
    "role": "viewer",
    "title": "Sorry, but we couldn't create a link to this content. Please try again later. Security validation failed. 'F42551255E9BED0FB76D1DC645B3E9DD6490E298CA02' does not exist. The error was caused by an internally generated issue. The error has been logged.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

次の例では、assignedUsersに指定されたユーザーが存在しないため、パブリック・リンクは作成されません。 

POST ...publiclinks/folder/F42551255E9BED0FB76D1DC645B3E9DD6490E298CA02

リクエスト・ヘッダー

なし。

リクエスト本文

{
	"assignedUsers": "invalid",
	"linkName": "MyLink5",
	"role": "viewer"
}

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "errorCode": "-25",
    "errorKey": "!csUnableToCreateSharedLink!csSharedLinkUserNotFound,invalid",
    "errorMessage": "Sorry, but we couldn't create a link to this content. Please try again later. User 'invalid' doesn't exist.",
    "errorType": "publiclink",
    "id": "F42591255E9BED0FB76D1DC645B3E9DD6490E298CA02",
    "linkName": "MyLink5",
    "role": "viewer",
    "title": "Sorry, but we couldn't create a link to this content. Please try again later. User 'invalid' doesn't exist.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
先頭に戻る