ドキュメント用REST API

機械翻訳について

フォルダおよびファイルの一括ダウンロード

post

/documents/api/1.2/folders/{folderId}/_download

指定したフォルダにあるファイルの、指定したグローバル一意識別子(GUID)の一括ダウンロードをリクエストします。

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: string

フォルダのグローバル一意識別子(GUID)。参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。 zip内のこのファイルはすべて、このフォルダの子である必要があります。

リクエスト本文では、圧縮されるファイルの詳細を定義します。

ルート・スキーマ : FolderCreateBulkZipBody

タイプ: object

リクエスト本文では、zipにコピーされるファイルの詳細を定義します。

ソースを表示

idList: string

(必須)zipにコピーされるグローバル一意識別子(GUID)のカンマ区切りリスト。リストには、folderIdの子であるファイルおよびフォルダGUIDを含めることができます。 selfフォルダは許可されていません。

{
    "description":"The request body defines details of what files are copied into the zip.",
    "properties":{
        "idList":{
            "type":"string",
            "description":"(Required) A comma seperated list of globally unique identifiers (GUIDs)to be copied into the zip. The list can contain file and folder GUIDs that are children of the <code>folderId</code>. The <code>self</code> folder is not allowed."
        }
    },
    "required":[
        "idList"
    ]
}

リクエストの例(application/json)

{
    "idList":"D890E0ADF2EB12AAD28D14372E82C5967A21F51BF794,FE27E70CA140E819250B4D365F48D86BC9097E77B3EE,DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

レスポンス本文には、zipビルド・ジョブに関する情報が含まれます。

ルート・スキーマ : FolderCreateBulkZipResponse

タイプ: object

レスポンス本文には、作成されたzipジョブに関する情報が含まれます。

ソースを表示

errorCode(optional): string

エラー・コードがゼロ(0)の場合は、エラーなしです
id(optional): string

zipジョブの親フォルダのプレフィクス付きGUID。
idList(optional): string

ファイルおよびフォルダのプレフィクス付きGUIDのリストをzipファイルにコピーしようとしました。
Location(optional): string

このジョブのステータスにアクセスするためのURL。
parentID(optional): string

zipジョブの親フォルダのGUID。
type(optional): string

アイテム・タイプfolder。

{
    "description":"The response body includes information about the created zip job.",
    "properties":{
        "Location":{
            "type":"string",
            "description":"The URL to access the status for this job."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "id":{
            "type":"string",
            "description":"The prefixed GUID of the parent folder for the zip job."
        },
        "idList":{
            "type":"string",
            "description":"The list of file and folder prefixed GUIDs attempted to be copied into the zip file."
        },
        "parentID":{
            "type":"string",
            "description":"The GUID of the parent folder for the zip job."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        }
    }
}

レスポンスの例(application/json)

{
    "Location":"OCEHost/documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/EF45E5E0A9F169D61CA387968719F5AA1614798736483",
    "errorCode":0,
    "id":"fFolderGUID:FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "idList":"fFileGUID:D890E0ADF2EB12AAD28D14372E82C5967A21F51BF794,fFolderGUID:FE27E70CA140E819250B4D365F48D86BC9097E77B3EE,fFileGUID:DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813",
    "parentID":"FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D,",
    "type":"folder"
}

400レスポンス

返されたエラーの説明に従い、リクエストは無効です。

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、同じディレクトリから2つのファイルを使用してzipを作成するようにリクエストします:

POST .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download

リクエスト・ヘッダー

なし。

リクエスト本文

{
"idList" : "DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "Location": "[OCEHost]/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/49D903D85D6FF82655A27207DFCC9A421614896992662",
    "errorCode": "0",
    "id": "fFolderGUID:FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "idList": "fFileGUID:DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,fFileGUID:DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813",
    "parentID": "FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "type": "folder"
}

例2

次の例では、同じディレクトリから2つのファイルと1つのディレクトリを使用してzipを作成するようにリクエストします:

POST .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download

リクエスト・ヘッダー

なし。

リクエスト本文

{
"idList" : "DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813,F4FB21E87B4014D99CCB8ACE09AA4CDC8253E338458C,FC7638FA224D9F5C8BB2285822063E7DD029B1209216"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "Location": "[OCEHost]/documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/22E6510E14B33436B6A40C85E00ABA3A1614897397141",
    "errorCode": "0",
    "id": "fFolderGUID:FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "idList": "fFileGUID:DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,fFileGUID:DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813,fFolderGUID:F4FB21E87B4014D99CCB8ACE09AA4CDC8253E338458C",
    "parentID": "FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "type": "folder"
}

例3

次の例では、同じディレクトリから2つのファイルと、別のロケーションから1つのディレクトリを使用してzipを作成するようにリクエストします :

POST .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download

リクエスト・ヘッダー

なし。

リクエスト本文

{
"idList" : "DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813,F4FB21E87B4014D99CCB8ACE09AA4CDC8253E338458C,FC7638FA224D9F5C8BB2285822063E7DD029B1209216"
}

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "errorCode": "-96",
    "errorKey": "!csBulkdownloadUnableToInitJob!csCloudBulkDownloadRequestItemsNotInParentFolder",
    "errorMessage": "Unable to start bulk download of files. One or more of the Ids are not located in the parent folder.",
    "errorType": "folder",
    "id": "fFolderGUID:FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "idList": "fFileGUID:DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,fFileGUID:DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813,fFolderGUID:F4FB21E87B4014D99CCB8ACE09AA4CDC8253E338458C,fFolderGUID:FC7638FA224D9F5C8BB2285822063E7DD029B1209216",
    "parentID": "FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "title": "Unable to start bulk download of files. One or more of the Ids are not located in the parent folder.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例4

次の例では、同じディレクトリから3つのファイルと1つのディレクトリを使用してzipを作成するようにリクエストしますが、ファイルは別のユーザーによって所有されます:

POST .../folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download

リクエスト・ヘッダー

なし。

リクエスト本文

{
"idList" : "DB01ED18668EF8ACDCFD169CB26F76D7CB5DA8E4FDDB,DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813,F4FB21E87B4014D99CCB8ACE09AA4CDC8253E338458C"
}

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csBulkdownloadUnableToInitJob!csCloudItemInsufficientPrivileges,ssvrint.cecsadmina,fFileGUID:DB01ED18668EF8ACDCFD169CB26F76D7CB5DA8E4FDDB,DOCS_BULK_BUILD_ZIP",
    "errorMessage": "Unable to start bulk download of files. User 'ssvrint.cecsadmina' has insufficient privilege to access fFileGUID:DB01ED18668EF8ACDCFD169CB26F76D7CB5DA8E4FDDB with service DOCS_BULK_BUILD_ZIP.",
    "errorType": "folder",
    "id": "fFolderGUID:FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "idList": "fFileGUID:DB01ED18668EF8ACDCFD169CB26F76D7CB5DA8E4FDDB,fFileGUID:DE27E70CA140E819250B4D365F48D86BC9097E77B3EE,fFileGUID:DC9AEA3E7F3AA1C07FCE4E46B7AC2B4F52F010D5A813",
    "parentID": "FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D",
    "title": "Unable to start bulk download of files. User 'ssvrint.cecsadmina' has insufficient privilege to access fFileGUID:DB01ED18668EF8ACDCFD169CB26F76D7CB5DA8E4FDDB with service DOCS_BULK_BUILD_ZIP.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る