ドキュメント用REST API

機械翻訳について

フォルダ取得

get

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

指定したフォルダのフォルダ情報を取得します。

リクエスト

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

application/json
application/xml

パス・パラメータ

folderId: string

フォルダのグローバル一意識別子(GUID)。参照されるフォルダがユーザーのホーム・フォルダの場合、folderIdの値はselfです。

ヘッダー・パラメータ

accessToken(optional): string

現在のユーザーにこのフォルダへのアクセスを許可するApplinkアクセス・トークン。このパラメータは、appLinkIDが使用されている場合は必須です。これはaccessTokenまたはAccessTokenとして使用できます。
appLinkID(optional): string

現在のユーザーにこのフォルダへのアクセスを許可するApplink ID。パラメータappLinkIDが使用されるときはいつでも、パラメータaccessTokenも提供されなければなりません。 appLinkIDまたはAppLinkIDとして使用できます。
dAccessCode(optional): string

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

現在のユーザーにこのフォルダへのアクセスを許可する、パブリック・リンクのパブリック・リンクID。 linkIDまたはLinkIDとして使用できます。

トップに戻る

レスポンス

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

application/json
application/xml

200レスポンス

レスポンス本文には、特定のフォルダに関する情報が含まれます。

ルート・スキーマ: FolderResponseWithConversation

タイプ: object

レスポンス本文には、フォルダに関する情報が含まれます。

ソースを表示

errorCode(optional): string

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

{
    "description":"The response body includes information about the folder.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FolderDefinitionWithConversation"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

すべてに一致

ソースを表示

object FolderDefinitionWithConversation

フォルダのメタデータ情報。

{
    "description":"The response body includes information about the folder.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FolderDefinitionWithConversation"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

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

タイプ: object

フォルダのメタデータ情報。

ソースを表示

childitemsCount(optional): string

フォルダに含まれるアイテムの数
conversationID(optional): string

このフォルダまたは親フォルダに関連付けられている会話ID。
createdBy(optional): object User

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

フォルダが作成された日付
description(optional): string

フォルダの説明。
id(optional): string

フォルダのグローバル一意識別子(GUID)。
isConversationInherited(optional): boolean

会話IDが現在のフォルダに関連付けられているか(false)、会話IDが親フォルダに関連付けられているか(true)を示すフラグ。
modifiedBy(optional): object User

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

フォルダが最終的に更新された日付
name(optional): string

フォルダ名。
ownedBy(optional): object User

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

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

含まれるファイルとフォルダをすべて含めたフォルダのサイズ(バイト単位)
type(optional): string

アイテム・タイプfolder。

{
    "description":"Folder metadata information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "parentID":{
            "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>"
        },
        "name":{
            "type":"string",
            "description":"Folder name."
        },
        "description":{
            "type":"string",
            "description":"Folder description."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>folder</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the folder in bytes, including all of the files and folders contained in the folder."
        },
        "childitemsCount":{
            "type":"string",
            "description":"Number of items contained in the folder."
        },
        "createdTime":{
            "type":"string",
            "description":"Date the folder was created."
        },
        "modifiedTime":{
            "type":"string",
            "description":"Date the folder was last modified."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "conversationID":{
            "type":"string",
            "description":"Conversation ID associated with this folder or a parent folder."
        },
        "isConversationInherited":{
            "type":"boolean",
            "description":"Flag indicating whether the conversation ID is associated with the current folder (false) or if the conversation ID is associated with a parent folder (true)."
        }
    }
}

ネストされたスキーマ: 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)

{
    "childItemsCount":"2",
    "createdBy":{
        "displayName":"User AA",
        "loginName":"userAALoginName",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "type":"user"
    },
    "createdTime":"2014-02-21T20:52:37Z",
    "errorCode":"0",
    "id":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "modifiedBy":{
        "displayName":"User AA",
        "loginName":"userAALoginName",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "type":"user"
    },
    "modifiedTime":"2014-02-21T20:52:37Z",
    "name":"foldera",
    "ownedBy":{
        "displayName":"User AA",
        "loginName":"userAALoginName",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "type":"user"
    }
}

レスポンスの例 (parentID)

self

レスポンスの例 (size)

レスポンスの例 (type)

folder

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したフォルダのフォルダ定義情報が返されます。

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "2",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T20:52:37Z",
    "errorCode": "0",
    "id": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T20:52:37Z",
    "name": "foldera",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "self",
    "size": "39",
    "type": "folder"
}

例2

次の例では、指定したフォルダのフォルダ定義情報が返されます。このフォルダには会話が関連付けられているため、conversationIDおよびisConversationInheritedという2つの新しいフィールドも返されます。

GET .../folders/F3EA22EE4F524F2931AAA841T0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "1",
    "conversationID": "39912",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2016-05-13T20:40:24Z",
    "errorCode": "0",
    "id": "F3EA22EE4F524F2931AAA841T0000000000100000001",
    "isConversationInherited": "false",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2016-05-13T20:40:24Z",
    "name": "folderB",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "self",
    "size": "0",
    "type": "folder"
}

例3

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

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "4",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-06T21:34:23Z",
    "description": "PublicLinkDemo",
    "errorCode": "0",
    "id": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-06T21:34:23Z",
    "name": "PublicLinkDemo",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "size": "1189",
    "type": "folder"
}

例4

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

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "4",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-06T21:34:23Z",
    "description": "PublicLinkDemo",
    "errorCode": "0",
    "id": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-06T21:34:23Z",
    "name": "PublicLinkDemo",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "size": "1189",
    "type": "folder"
}

例5

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

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-20",
    "errorKey": "!csCloudItemInsufficientPrivileges,User BB,fFolderGUID:FF4729683CD68C1AFB1AE87DT0000000000100000001,FLD_INFO",
    "errorMessage": "User 'User BB' has insufficient privilege to access fFolderGUID:FF4729683CD68C1AFB1AE87DT0000000000100000001 with service FLD_INFO.",
    "errorType": "folder",
    "id": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "title": "User 'User BB' has insufficient privilege to access fFolderGUID:FF4729683CD68C1AFB1AE87DT0000000000100000001 with service FLD_INFO.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例6

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

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

{
    "errorCode": "-18",
    "errorKey": "!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "The access code must be provided to access the link.",
    "errorType": "folder",
    "id": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "title": "The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例7

次の例では、指定したフォルダのフォルダ定義情報が返されます。現在のユーザーが所有していない、または共有していないフォルダ構造の下にあるため、この例ではapplinkを使用しています。 applink IDとアクセス・トークンはリクエスト・ヘッダーに送信されます。

GET .../folders/F4927423081AA3C261E1D45AB5D17B95F47087F4E518

リクエスト・ヘッダー

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "0",
    "createdBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-15T21:08:54Z",
    "description": "subFolderTestByUserB CONTRIBUTOR applink",
    "errorCode": "0",
    "id": "F4927423081AA3C261E1D45AB5D17B95F47087F4E518",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-15T21:08:54Z",
    "name": "subFolderTestByUserB",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "size": "0",
    "type": "folder"
}

先頭に戻る