ファイルApplink作成
post
/documents/api/1.2/applinks/file/{fileId}
指定したファイルと指定したユーザーのApplinkを作成します。
指定されたユーザーに次のロールを付与できます:
- ビューア: ビューアはファイルおよびフォルダを表示できますが、何かを変更することはできません。
- ダウンローダ: ダウンローダはファイルをダウンロードし、自分のコンピュータに保存することもできます。
- コントリビュータ: コントリビュータはファイルの変更、ファイルの更新、新規ファイルのアップロードおよびファイルの削除を行うこともできます。
- マネージャ: マネージャは、ファイルの変更、ファイルの更新、新しいファイルのアップロード、ファイルの削除および共有を行うこともできます。
ノート:
Applinkを作成するには、リクエスタにそのファイルに対する管理権限が必要です。 つまり、リクエスタは所有者であるか、管理者ロールが必要ということです。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
パス・パラメータ
- fileId: string
フォルダのグローバル一意識別子(GUID)。
リクエスト本文では、applink作成リクエストの詳細を定義します。 Boldは必須の値を示します。
ルート・スキーマ: ApplinkBody
タイプ:
objectリクエスト本文では、applink作成リクエストの詳細を定義します。 Boldは必須の値を示します。
- assignedUser: string
ユーザーの識別子。 これにはグローバル一意識別子(GUID)などの識別子を指定できます。
- role (オプション): string
使用可能な値:
[ "viewer", "downloader", "contributor", "manager" ]共有アイテムへのアクセス・レベル(roleキーワードは小文字である必要があります):
- viewer (デフォルト)
- downloader
- contributor
- manager
- userLocale(optional): string
applinkに使用されるロケール。 ロケールは、時間などの値の表示に影響を及ぼす場合があります。
- userTimeZone(optional): string
applinkに使用されるタイムゾーン。 タイムゾーンは、時間値の解釈方法に影響します。
リクエストの例(application/json)
{
"assignedUser":"U0EAA20910FAF3052ACB79E4T00000000001",
"role":"contributor",
"userLocale":"Dansk",
"userTimeZone":"Canada/Pacific"
}レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200レスポンス
リクエストが処理されました。
ルート・スキーマ: ApplinkResponse
タイプ:
objectレスポンス本文には、applinkに関する情報が含まれます
ソースを表示
- accessToken(optional): string
この要素は、リソースへのアクセス権を提供し、15分後に失効します。 アクセス・トークンは、リフレッシュ・トークンによって定義されている時間(24時間)内に任意の回数リフレッシュできます。
- appLinkID(optional): string
この要素は、リソースを一意に識別します。
- appLinkUrl(optional): string
リソースのURL。
- errorCode(optional): string
エラー・コードがゼロ(0)の場合は、エラーなしです
- id(optional): string
共有アイテムのグローバル一意識別子(GUID)。
- refreshToken(optional): string
この要素では、現在のアクセス・トークンが失効したときに、新しいアクセス・トークンをリクエストできます。 リフレッシュされたトークンは24時間後に失効します。
- role (オプション): string
共有アイテムへのアクセス・レベル
- type(optional): string
アイテム・タイプ
applink。
レスポンスの例(application/json)
{
"appLinkID":"LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==",
"accessToken":"GYrSN5zuj0kOTE4k_60bKvdkxx2-ARA546A2T77GtEOgoPZPGgKk126OeCn1w-Ij",
"appLinkUrl":"http://www.example.com/documents/embed/link/app/LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==/fileview/DFD11F62E911327CB1F160F6T0000000000100000001",
"refreshToken":"Yc_b_dE8V03eDTCmcmC1gi_y3LVJTPiZOSQDhuS_VWim9E_FRpLQGtEhgxCNbKTG",
"role":"contributor",
"id":"DFD11F62E911327CB1F160F6T0000000000100000001",
"type":"applink",
"errorCode":"0"
}400レスポンス
リクエスト・パラメータが正しい形式ではありません。
403レスポンス
ユーザーに読取り権限がない場合は禁止されています。
404レスポンス
ファイルIDが見つかりません。
例
次の例では、指定したファイルに対する管理者レベルのアクセス権を指定したユーザーに付与します。
POST .../applinks/file/DFD11F62E911327CB1F160F6T0000000000100000001
リクエスト・ヘッダー
なし。
リクエスト本文
{
"assignedUser": "U0EAA20910FAF3052ACB79E4T00000000001",
"role": "manager",
"userLocale": "Japanese"
}
HTTPステータス・コード
HTTP_STATUS = 200
JSONレスポンス
{
"accessToken": "GYrSN5zuj0kOTE4k_60bKvdkxx2-ARA546A2T77GtEOgoPZPGgKk126OeCn1w-Ij",
"appLinkID": "LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==",
"appLinkUrl": "http://www.example.com/documents/embed/link/app/LDhsn4VPTsnDnKpKLFZTCkjaPkYbMC6-3taYSdJAazckhezJ2HlSjs2THOou6cCAvxcRnw5gpXcU7pIRkCmWN8kEToJHFwwZ-ptWvPGhJaiirl9baL9mka14WnwpL6auOO40-gFMPvkPv23OtMnj2W3A==/fileview/DFD11F62E911327CB1F160F6T0000000000100000001",
"errorCode": "0",
"id": "DFD11F62E911327CB1F160F6T0000000000100000001",
"refreshToken": "Yc_b_dE8V03eDTCmcmC1gi_y3LVJTPiZOSQDhuS_VWim9E_FRpLQGtEhgxCNbKTG",
"role": "manager",
"type": "applink"
}