ドキュメント用REST API

機械翻訳について

すべてのRESTエンドポイント

Applinks

Applinks APIによって、基本的なapplink操作が可能になります。

ファイルApplink作成: メソッド: post
パス: /documents/api/1.2/applinks/file/{fileId}
フォルダApplink作成: メソッド: post
パス: /documents/api/1.2/applinks/folder/{folderId}
Applinkトークン・リフレッシュ: メソッド: put
パス: /documents/api/1.2/applinks/token

カタログ

カタログAPIは、特定のバージョンで使用可能なリソースに関する情報を提供します。

すべてのバージョンの取得: メソッド: get
パス: /documents/api/
APIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog
Applink APIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/applinks
構成APIカタログを取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/configuration
ファイルAPIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/files
フォルダAPIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/folders
メタデータAPIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/metadata
パブリック・リンクAPIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/publiclinks
共有APIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/shares
サイトAPIカタログを取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/sites
特定バージョンの取得: メソッド: get
パス: /documents/api/{version}
テンプレートAPIカタログを入手: メソッド: get
パス: /documents/api/{version}/metadata-catalog/templates
ユーザーAPIカタログの取得: メソッド: get
パス: /documents/api/{version}/metadata-catalog/users

クライアント・アプリケーション

クライアント・アプリケーション・カテゴリの操作。

クライアント・アプリケーションの作成: メソッド: post
パス: /documents/api/1.2/config/clientApplications
クライアント・アプリケーションの削除: メソッド: delete
パス: /documents/api/1.2/config/clientApplications/{id}
クライアント・アプリケーション・ファイルのダウンロード: メソッド: get
パス: /documents/api/1.2/config/clientApplications/{id}/data
クライアント・アプリケーションの取得: メソッド: get
パス: /documents/api/1.2/config/clientApplications/{id}
すべてのクライアント・アプリケーションの取得: メソッド: get
パス: /documents/api/1.2/config/clientApplications
クライアント・アプリケーションの更新: メソッド: put
パス: /documents/api/1.2/config/clientApplications/{id}

構成

構成APIは、基本的な構成操作を提供します。

CDN構成の取得: メソッド: get
パス: /documents/api/1.2/config/sites/deliverycdn
コラボレーション構成の取得: メソッド: get
パス: /documents/api/1.2/config/collaboration
電子メール通知構成の取得: メソッド: get
パス: /documents/api/1.2/config/notification/email
電子メール通知構成の設定: メソッド: put
パス: /documents/api/1.2/config/notification/email

ファイル

ファイルAPIによって、基本的なファイル操作が可能になります。

抽出ジョブの中止: メソッド: delete
パス: /documents/api/1.2/files/{fileId}/_extract/{jobId}
メタデータ・コレクションのファイルへの割当て: メソッド: post
パス: /documents/api/1.2/files/{fileId}/metadata/{collectionName}
ファイル・メタデータ・コレクションへの値の割当て: メソッド: post
パス: /documents/api/1.2/files/{fileId}/metadata
ファイル・コピー: メソッド: post
パス: /documents/api/1.2/files/{fileId}/copy
ファイル会話を作成: メソッド: post
パス: /documents/api/1.2/files/{fileId}/conversation
すべてのファイル・タグの削除: メソッド: delete
パス: /documents/api/1.2/files/{fileId}/tags
カスタム・レンディションの削除: メソッド: delete
パス: /documents/api/1.2/files/{fileId}/data/rendition
ファイル削除: メソッド: delete
パス: /documents/api/1.2/files/{fileId}
ファイル・メタデータ・コレクションの値の削除: メソッド: delete
パス: /documents/api/1.2/files/{fileId}/metadata
ファイル・ダウンロード: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data
ファイル編集: メソッド: put
パス: /documents/api/1.2/files/{fileId}
ファイル・タグの編集: メソッド: put
パス: /documents/api/1.2/files/{fileId}/tags
フォルダへのZIPファイルの抽出: メソッド: post
パス: /documents/api/1.2/files/{fileId}/_extract
ファイル・レンディション生成: メソッド: post
パス: /documents/api/1.2/files/{fileId}/pages
ファイル・アクセス権の取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/accesses
ファイル割当てメタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/metadataFields
ファイルのHTML5プレビューの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/previewPath
ファイル情報取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}
ファイル・メタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/metadata
ファイル・タグの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/tags
ファイル・バージョン取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/versions
複数のファイルに関する情報の取得: メソッド: get
パス: /documents/api/1.2/files/lists
レンディション取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/rendition
レンディション・ページ・カウント取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/pages
レスポンシブ・ラージ・イメージを取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/largeImage
レスポンシブ・ミディアム・イメージを取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/mediumImage
レスポンシブ・スモール・イメージを取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/smallImage
レスポンシブ・サムネイル・イメージを取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/thumbnailImage
抽出ジョブのステータスの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/_extract/{jobId}
サムネイル取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/thumbnail
リストのレンディション: メソッド: get
パス: /documents/api/1.2/files/{fileId}/data/renditions
ファイル移動: メソッド: post
パス: /documents/api/1.2/files/{fileId}/move
ファイル予約: メソッド: post
パス: /documents/api/1.2/files/{fileId}/reserve
ファイル・タグの設定: メソッド: post
パス: /documents/api/1.2/files/{fileId}/tags
ファイル予約解除: メソッド: post
パス: /documents/api/1.2/files/{fileId}/unreserve
カスタム・レンディションのアップロード: メソッド: post
パス: /documents/api/1.2/files/{fileId}/data/rendition
ファイル・アップロード: メソッド: post
パス: /documents/api/1.2/files/data
ファイル・バージョン・アップロード: メソッド: post
パス: /documents/api/1.2/files/{fileId}/data

フォルダ

フォルダAPIには、基本的なフォルダ操作が用意されています。

一括ダウンロード・ジョブの中断: メソッド: delete
パス: /documents/api/1.2/folders/{folderId}/_download/{jobId}
メタデータ・コレクションのフォルダへの割当て: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/metadata/{collectionName}
フォルダ・メタデータ・コレクションへの値の割当て: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/metadata
フォルダの一括作成: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/_bulkCreate
フォルダおよびファイルの一括ダウンロード: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/_download
フォルダの所有権の変更: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/changeOwnership
フォルダ・コピー: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/copy
フォルダ作成: メソッド: post
パス: /documents/api/1.2/folders/{folderId}
フォルダの会話を作成: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/conversation
すべてのフォルダ・タグの削除: メソッド: delete
パス: /documents/api/1.2/folders/{folderId}/tags
フォルダ削除: メソッド: delete
パス: /documents/api/1.2/folders/{folderId}
フォルダ・メタデータ・コレクションの値の削除: メソッド: delete
パス: /documents/api/1.2/folders/{folderId}/metadata
一括ダウンロード・ジョブ・ファイルのダウンロード: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/_download/{jobId}/package
フォルダ編集: メソッド: put
パス: /documents/api/1.2/folders/{folderId}
フォルダ・タグの編集: メソッド: put
パス: /documents/api/1.2/folders/{folderId}/tags
フォルダ取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}
フォルダ割当てメタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/metadataFields
フォルダ・メタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/metadata
フォルダ・タグの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/tags
ホーム・フォルダ・コンテンツの取得: メソッド: get
パス: /documents/api/1.2/folders/items
複数のフォルダに関する情報の取得: メソッド: get
パス: /documents/api/1.2/folders/lists
特定フォルダ・コンテンツの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/items
一括ダウンロード・ジョブのステータスの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/_download/{jobId}
フォルダの移動: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/move
フォルダまたはファイルの検索: メソッド: get
パス: /documents/api/1.2/folders/search/items
特定フォルダIDのフォルダまたはファイルの検索: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/search/items
フォルダ・タグの設定: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/tags

メタデータ・コレクション

メタデータ・コレクション・カテゴリの操作。

メタデータ・コレクションのファイルへの割当て: メソッド: post
パス: /documents/api/1.2/files/{fileId}/metadata/{collectionName}
メタデータ・コレクションのフォルダへの割当て: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/metadata/{collectionName}
ファイル・メタデータ・コレクションへの値の割当て: メソッド: post
パス: /documents/api/1.2/files/{fileId}/metadata
フォルダ・メタデータ・コレクションへの値の割当て: メソッド: post
パス: /documents/api/1.2/folders/{folderId}/metadata
メタデータ・コレクションの作成: メソッド: post
パス: /documents/api/1.2/metadata/{collectionName}
メタデータ・コレクション削除: メソッド: delete
パス: /documents/api/1.2/metadata/{collectionName}
フォルダ・メタデータ・コレクションの値の削除: メソッド: delete
パス: /documents/api/1.2/folders/{folderId}/metadata
ファイル・メタデータ・コレクションの値の削除: メソッド: delete
パス: /documents/api/1.2/files/{fileId}/metadata
Metadataコレクションのフィールドの編集: メソッド: put
パス: /documents/api/1.2/metadata/{collectionName}/field
Metadataコレクションの編集: メソッド: put
パス: /documents/api/1.2/metadata/{collectionName}
使用可能なMetadataコレクションの取得: メソッド: get
パス: /documents/api/1.2/metadata
ファイル割当てメタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/metadataFields
ファイル・メタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/files/{fileId}/metadata
フォルダ割当てメタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/metadataFields
フォルダ・メタデータ・コレクションの取得: メソッド: get
パス: /documents/api/1.2/folders/{folderId}/metadata
メタデータ・コレクション定義の取得: メソッド: get
パス: /documents/api/1.2/metadata/{collectionName}
検索可能なメタデータ・フィールドの取得: メソッド: get
パス: /documents/api/1.2/metadata/searchFields
検索可能なメタデータ・フィールドの設定: メソッド: post
パス: /documents/api/1.2/metadata/searchFields
ファイル・アップロード: メソッド: post
パス: /documents/api/1.2/files/data
ファイル・バージョン・アップロード: メソッド: post
パス: /documents/api/1.2/files/{fileId}/data

Publiclinks

Publiclinks APIは、基本的なパブリック・リンク操作を提供

ファイル・パブリック・リンク作成: メソッド: post
パス: /documents/api/1.2/publiclinks/file/{fileId}
フォルダ・パブリック・リンク作成: メソッド: post
パス: /documents/api/1.2/publiclinks/folder/{folderId}
パブリック・リンク削除: メソッド: delete
パス: /documents/api/1.2/publiclinks/{linkId}
パブリック・リンク編集: メソッド: put
パス: /documents/api/1.2/publiclinks/{linkId}
ファイル・パブリック・リンク取得: メソッド: get
パス: /documents/api/1.2/publiclinks/file/{fileId}
フォルダ・パブリック・リンク取得: メソッド: get
パス: /documents/api/1.2/publiclinks/folder/{folderId}
パブリック・リンク取得: メソッド: get
パス: /documents/api/1.2/publiclinks/{linkId}

共有APIによって、基本的な共有操作が可能になります。

共有フォルダ・ユーザー・ロールの編集: メソッド: put
パス: /documents/api/1.2/shares/{folderId}/role
共有フォルダ・ユーザーの取得: メソッド: get
パス: /documents/api/1.2/shares/{folderId}/items
現行ユーザーの失効: メソッド: delete
パス: /documents/api/1.2/shares/{folderId}/myuser
ユーザーの失効: メソッド: delete
パス: /documents/api/1.2/shares/{folderId}/user
フォルダ共有: メソッド: post
パス: /documents/api/1.2/shares/{folderId}
フォルダ共有解除: メソッド: delete
パス: /documents/api/1.2/shares/{folderId}

サイト

Sites APIは基本的なサイト操作を提供します。

サイトからサイトを作成: メソッド: post
パス: /documents/api/1.2/sites/{siteId}/site

テンプレート

Templates APIは、基本的なテンプレート操作を提供します。

テンプレートからサイトを作成: メソッド: post
パス: /documents/api/1.2/templates/{templateId}/site

ユーザー

ユーザーAPIは、フォルダおよびファイル共有の目的で、ユーザーを識別する基本情報を提供します。

電子メール・アドレスを持つユーザーの取得: メソッド: get
パス: /documents/api/1.2/users/search/items
ユーザーの取得: メソッド: get
パス: /documents/api/1.2/users/items
ユーザー・コンテンツの転送: メソッド: post
パス: /documents/api/1.2/users/{userID}/transferContent