ドキュメント用REST API

機械翻訳について

フォルダへのZIPファイルの抽出

post

/documents/api/1.2/files/{fileId}/_extract

ZIPファイルをフォルダに抽出するようリクエストします。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

フォルダに抽出されるZIPファイルのグローバル一意識別子(GUID)

リクエスト本文では、ZIPファイルからファイルを抽出する方法の詳細を定義します。

ルート・スキーマ : FileExtractZipBody

タイプ: object

リクエスト本文では、zip内のファイルの抽出方法を定義します。

ソースを表示

destinationID(optional): string

ファイルを抽出する宛先フォルダのグローバル一意識別子(GUID)を指定します。デフォルトでは、zipコンテンツはzipファイルと同じフォルダに抽出されます。
duplicateResolution(optional): string
zipコンテンツと既存のファイル間の名前の競合をzipの抽出時に処理する方法を指定します。デフォルトはResolveDuplicatesです:
- ResolveDuplicates抽出では、競合する名前を解決して、新しいファイル名をいくつか追加します。
- ReviseDuplicates抽出では、競合するドキュメントの新しいリビジョンが作成されます。
- SkipDuplicates抽出では、競合するファイル名がスキップされます

{
    "description":"The request body defines how the files in the zip are extracted.",
    "properties":{
        "destinationID":{
            "type":"string",
            "description":"Specify the globally unique identifier (GUID) of the destination folder to extract files. By default the zip contents will be extracted to the same folder as the zip file."
        },
        "duplicateResolution":{
            "type":"string",
            "description":"Specify how name conflicts between the zip contents and existing files are handled during zip extraction, the default is <code>ResolveDuplicates</code>:<ul><li><code>ResolveDuplicates</code> the extraction will resolve the conflicting name to append a number new file name.</li><li><code>ReviseDuplicates</code> the extraction will create a new revision of the conflicting document.</li><li><code>SkipDuplicates</code> the extraction will skip the conflicting file name</li></ul>"
        }
    }
}

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

{
    "duplicateResolution":"SkipDuplicates",
    "destinationID":"F4C639F3689B23DC9ADAA8CFC0E6EC85DE64738F6108"
}

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

レスポンス本文には、抽出ジョブに関する情報が含まれます。

ルート・スキーマ : FileExtractZipResponse

タイプ: object

レスポンス本文には、zip抽出ジョブに関する情報が含まれます。

ソースを表示

destinationID(optional): string

zipが抽出されるフォルダのGUID。
errorCode(optional): string

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

抽出するzipファイルのGUID。
jobId(optional): string

抽出ジョブのGUID。
Location(optional): string

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

アイテム・タイプfile。

{
    "description":"The response body includes information about the zip extraction 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 GUID of the zip file to be extracted."
        },
        "destinationID":{
            "type":"string",
            "description":"The GUID of the folder where the zip will be extracted."
        },
        "jobId":{
            "type":"string",
            "description":"The GUID of the extraction job."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        }
    }
}

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

{
    "Location":"OCMHost/documents/api/1.2/files/D9D9A930B13B25738ACC428B3C6239D683D39CFFC811/_extract/ZX-857509DEBFD7422FFD8D1BF081A9748F1642699937903",
    "destinationID":"F4C639F3689B23DC9ADAA8CFC0E6EC85DE64738F6108",
    "errorCode":"0",
    "id":"D9D9A930B13B25738ACC428B3C6239D683D39CFFC811",
    "jobId":"ZX-857509DEBFD7422FFD8D1BF081A9748F1642699937903",
    "type":"file"
}

400レスポンス

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

403レスポンス

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

404レスポンス

ファイルIDが見つかりません。

トップに戻る

例

3つのイメージを含むzipをアップロードした後、次の例では、アップロードされたzipと同じフォルダにイメージを抽出する抽出ジョブを作成します。

POST .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "Location": "{OCEHost}/documents/api/1.2/files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-E83150A29A911D33321FE8A9A6C5814F1643066913096",
    "destinationID": "F80BA045E86F1651028073CA910CABD1145F5DE8845B",
    "errorCode": "0",
    "id": "DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317",
    "jobId": "ZX-E83150A29A911D33321FE8A9A6C5814F1643066913096",
    "type": "file"
}

例2

3つのイメージを含むzipをアップロードし、抽出するフォルダを作成すると、次の例では、指定したフォルダにイメージを抽出する抽出ジョブを作成します。

POST .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D7D"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "Location": "{OCEHost}/documents/api/1.2/files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-1032527C9CEAC3CFB0BD3BA8C45BD3EA1643125120730",
    "destinationID": "F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D7D",
    "errorCode": "0",
    "id": "DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317",
    "jobId": "ZX-1032527C9CEAC3CFB0BD3BA8C45BD3EA1643125120730",
    "type": "file"
}

例3

3つのイメージを含むzipをアップロードして抽出するフォルダを作成すると、次の例では、指定したフォルダにイメージを抽出して既存のファイルの新しいバージョンを作成する抽出ジョブを作成します。

POST .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D7D",
    "duplicateResolution": "ReviseDuplicates"
}

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "Location": "{OCEHost}/documents/api/1.2/files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract/ZX-D51C9BDBAED077E16488336117420E231643125878509",
    "destinationID": "F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D7D",
    "errorCode": "0",
    "id": "DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317",
    "jobId": "ZX-D51C9BDBAED077E16488336117420E231643125878509",
    "type": "file"
}

例4

この例は、指定されたフォルダが存在しないため失敗します。

POST .../files/DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317/_extract

リクエスト・ヘッダー

なし。

リクエスト本文

{
    "destinationID": "F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D8D",
    "duplicateResolution": "ReviseDuplicates"
}

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
    "destinationID": "F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D8D",
    "errorCode": "-16",
    "errorKey": "!csBulkExtractionUnableToInitJob!csFldDoesNotExist,F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D8D",
    "errorMessage": "Unable to initialize extraction job. 'F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D8D' does not exist.",
    "errorType": "file",
    "id": "DC765D5CD846E67B395AE676435D1DBF0C5B3FCDE317",
    "title": "Unable to initialize extraction job. 'F1DDD707F795A50AADBCCCAB5EB016D8E77A30902D8D' does not exist.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る