ドキュメント用REST API

機械翻訳について

ファイル予約

post

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

指定したファイルを予約します。ファイル予約は、ファイルが使用中であることを他のユーザー(またはプロセス)に示します。

リクエスト

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

application/json
application/xml

パス・パラメータ

fileId: string

ファイルのグローバル一意識別子(GUID)。

ヘッダー・パラメータ

dAccessCode(optional): string

保護されたパブリック・リンクを使用するために必要なアクセス・コード。次の形式のCookieヘッダーの一部として送信する必要があります: dAccessCode-<linkID>=<passcodeValue>
linkID(optional): string

現在のユーザーにこのファイルへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。機能させるには、このパブリック・リンクにコントリビュータ・ロールが付与されている必要があります。 linkIDまたはLinkIDとして使用できます。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

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

ルート・スキーマ: FileReserveResponse

タイプ: object

レスポンス本文には、予約操作に関する情報が含まれます。

ソースを表示

errorCode(optional): number

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

ファイルのグローバル一意識別子(GUID)。
reservationDate(optional): string

親フォルダのグローバル一意識別子(GUID)。親フォルダがユーザーのホーム・フォルダの場合、parentIDの値はselfです。
.
reservedBy(optional): object User

ユーザー情報
type(optional): string

アイテム・タイプfile。

{
    "description":"The response body includes information about the reserve operation.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "reservationDate":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>."
        },
        "reservedBy":{
            "$ref":"#/definitions/User"
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

ネストされたスキーマ: User

タイプ: object

ユーザー情報

ソースを表示

displayName(optional): string

ユーザーの表示名
id(optional): string

ユーザーのグローバル一意識別子(GUID)。
loginName(optional): string

ユーザーのログイン名。
type(optional): string

アイテム・タイプuser。

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

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

{
    "id":"D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationDate":"2015-06-15T19:34:17.000Z",
    "reservedBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "type":"file",
    "errorCode":"0"
}

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したファイルを予約します。

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationDate": "2015-06-15T19:34:17Z",
    "reservedBy": {
       	"displayName": "User AA",
	"id": "U0EAA20910FAF3052ACB79E4T00000000001",
	"loginName": "userAALoginName",
	"type": "user"
    },
    "type": "file"
}

例2

次の例では、指定したファイルを予約します。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、パブリック・リンクIDを使用します。

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationTime": "2016-06-30T21:16:22Z",
    "reservedBy": {
        "displayName": "User BB",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "loginName": "userBBLoginName",
        "type": "user"
    },
    "type": "file"
}

例3

次の例では、指定したファイルを予約します。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、この例では、アクセス・コードで保護されているパブリック・リンクIDを使用します。アクセス・コード( test12345)は、Cookieの一部としてリクエスト・ヘッダーに発行されます。

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "errorCode": "0",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "reservationTime": "2016-06-30T21:16:22Z",
    "reservedBy": {
        "displayName": "User BB",
        "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
        "loginName": "userBBLoginName",
        "type": "user"
    },
    "type": "file"
}

例4

次の例では、指定したファイルの予約をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあるため、アクセス拒否エラー・メッセージが返されます。

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csFldCouldNotSetReservation!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD,FLD_SET_RESERVATION",
    "errorMessage": "Could not set reservation. User 'User BB' has insufficient privilege to access fFileGUID:D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD with service FLD_SET_RESERVATION.",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "title": "Could not set reservation. User 'User BB' has insufficient privilege to access fFileGUID:D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD with service FLD_SET_RESERVATION.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

次の例では、指定したファイルの予約をリクエストします。このファイルは現在のユーザーに所有または共有されていないフォルダ構造にあります。また、アクセス・コードで保護されているパブリック・リンクのみを使用可能です。アクセス・コードがリクエストの一部として送信されなかったため、エラーが返されます。

POST .../files/D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD/reserve

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-18",
    "errorKey": "!csFldCouldNotSetReservation!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Could not set reservation. The access code must be provided to access the link.",
    "id": "D5B8B54BA8C121BEDB91A1341212FF6185DEA5EFC0BD",
    "title": "Could not set reservation. The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る