機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. フォルダ

特定フォルダ・コンテンツの取得

get

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

指定したフォルダで、子アイテム(フォルダとファイル)のコレクションを取得します。 typeフィールドは、アイテムがフォルダかファイルかを示します。

リクエスト

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

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

問合せパラメータ

  • 結果を絞り込み、指定した文字列と正確に名前が一致するフォルダとファイルのみにします。 完全一致がない場合、コールは空のリストを返します。 たとえば、次のパラメータの場合、TestFolderという名前のフォルダ(またはファイル)にレスポンスが制限されます。 

    filterName=TestFolder

    フィルタにより、次のレスポンス・パラメータの動作が変更されます。

    • count: filterNameパラメータと一致するアイテムの数。
    • totalResults: filterNameパラメータと一致するアイテムの数。

  • 返されるアイテムの最大数を指定します。 1ページの結果に含めるアイテム数を指定する場合は、このパラメータを使用します。 デフォルトは50で、最大は10000です。 次の例では、返されるアイテムの数を10に制限しています。 

    limit=10

  • アクションで返されるアイテムの全セットの中で、アイテムのリストを始める位置を指定します。 offsetを指定しない場合、返されるアイテムはリストの最初のアイテムで始まります(offset=0)。

    返されるアイテムの全セットから、特定ページの結果について開始地点を指定する場合は、このパラメータを使用します。 次の例では、1ページあたりのアイテム数を10に制限し、2ページ目の結果を表示します(アイテム11-20): 

    limit=10&offset=10

  • 取得されたアイテムを、指定したフィールドおよびソート順で並べ替えます。 name、createdTimeおよびmodifiedTimeフィールド、ならびに昇順(asc)または降順(desc)のソート順を使用できます。 たとえば、デフォルトは次のようになります。 

    orderby=name:asc

ヘッダー・パラメータ

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

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

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

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

トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: SpecificFolderContents
タイプ: object
ソースを表示
ネストされたスキーマ: User
タイプ: object
ユーザー情報
ソースを表示
ネストされたスキーマ: items
タイプ: array
フォルダ内のファイルおよびサブフォルダ。
ソースを表示
ネストされたスキーマ : FileAndSubFoldersItemsDefinition
タイプ: object
フォルダ内のファイルおよびサブフォルダ。
ソースを表示
レスポンスの例(application/json)
{
    "count":"2",
    "totalResults":"2",
    "hasMore":"0",
    "errorCode":"0",
    "id":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "parentID":"self",
    "name":"foldera",
    "description":"rest folder",
    "type":"folder",
    "size":"39",
    "childItemsCount":"2",
    "createdTime":"2014-02-21T20:52:37Z",
    "modifiedTime":"2014-02-21T20:52:37Z",
    "createdBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "ownedBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "modifiedBy":{
        "displayName":"User AA",
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "loginName":"userAALoginName",
        "type":"user"
    },
    "items":[
        {
            "id":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "name":"restFolder",
            "type":"folder",
            "size":"39",
            "childItemsCount":"1",
            "createdTime":"2014-02-21T20:54:50Z",
            "modifiedTime":"2014-02-21T20:54:50Z",
            "createdBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            }
        },
        {
            "id":"DB1C5AF480FFE61C588027A8T0000000000100000001",
            "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "name":"example.txt",
            "type":"file",
            "size":"13",
            "version":"1",
            "createdTime":"2014-02-21T21:32:37Z",
            "modifiedTime":"2014-02-21T21:32:37Z",
            "createdBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "ownedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            },
            "modifiedBy":{
                "displayName":"User AA",
                "id":"U0EAA20910FAF3052ACB79E4T00000000001",
                "loginName":"userAALoginName",
                "type":"user"
            }
        }
    ]
}

400レスポンス

リクエスト・パラメータが正しい形式ではありません。

403レスポンス

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

404レスポンス

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

トップに戻る

例

次の例では、指定したフォルダの子アイテムのリストが返されます。

GET .../folders/FF4729683CD68C1AFB1AE87DT0000000000100000001/items?orderby=name:asc&limit=2&offset=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "2",
    "count": "2",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T20:52:37Z",
    "errorCode": "0",
    "hasMore": "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",
    "totalResults": "2",
    "type": "folder",
    "items": [
        {
            "type": "folder",
            "id": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
            "parentID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "name": "restFolder",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "createdTime": "2014-02-21T20:54:50Z",
            "modifiedTime": "2014-02-21T20:54:50Z",
            "description": "rest folder",
            "size": "39",
            "childItemsCount": "1"
        },
        {
            "type": "file",
            "id": "DB1C5AF480FFE61C588027A8T0000000000100000001",
            "parentID": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "name": "example.txt",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "createdTime": "2014-02-21T21:32:37Z",
            "modifiedTime": "2014-02-21T21:32:37Z",
            "size": "13",
            "version": "1"
        }
    ]
}

例2

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

GET .../folders/F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518/items?orderby=name:asc&limit=2&offset=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "5",
    "count": "2",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-06T21:34:23Z",
    "description": "PublicLinkDemo",
    "errorCode": "0",
    "hasMore": "1",
    "id": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "limit": "2",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-06T21:34:23Z",
    "name": "PublicLinkDemo",
    "offset": "1",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "size": "1189",
    "totalResults": "5",
    "type": "folder",
    "items": [
        {
            "type": "folder",
            "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "name": "UserBBFolderUpdated",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "createdTime": "2016-06-30T23:34:21Z",
            "modifiedTime": "2016-07-01T00:01:46Z",
            "description": "User BB folder created via public link - updated",
            "size": "0",
            "childItemsCount": "0"
        },
        {
            "type": "folder",
            "id": "F3F6E41BF546376BD3FC6638B5D17B95F47087F4E518",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "name": "UserBFolderDemo",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "createdTime": "2016-06-06T21:40:24Z",
            "modifiedTime": "2016-06-06T21:40:24Z",
            "description": "UserBFolderDemo",
            "size": "0",
            "childItemsCount": "0"
        }
    ]
}

例3

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

GET .../folders/F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518/items?orderby=name:asc&limit=2&offset=1

リクエスト・ヘッダー

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "5",
    "count": "2",
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2016-06-06T21:34:23Z",
    "description": "PublicLinkDemo",
    "errorCode": "0",
    "hasMore": "1",
    "id": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "limit": "2",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2016-06-06T21:34:23Z",
    "name": "PublicLinkDemo",
    "offset": "1",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "type": "user"
    },
    "size": "1189",
    "totalResults": "5",
    "type": "folder",
    "items": [
        {
            "type": "folder",
            "id": "F81175D40FF57F19884AED0CB5D17B95F47087F4E518",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "name": "UserBBFolderUpdated",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "createdTime": "2016-06-30T23:34:21Z",
            "modifiedTime": "2016-07-01T00:01:46Z",
            "description": "User BB folder created via public link - updated",
            "size": "0",
            "childItemsCount": "0"
        },
        {
            "type": "folder",
            "id": "F3F6E41BF546376BD3FC6638B5D17B95F47087F4E518",
            "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
            "name": "UserBFolderDemo",
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "createdBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User BB",
                "loginName": "userBBLoginName",
                "id": "U6A0B35B0548F250914D18FDB5D17B95F470",
                "type": "user"
            },
            "createdTime": "2016-06-06T21:40:24Z",
            "modifiedTime": "2016-06-06T21:40:24Z",
            "description": "UserBFolderDemo",
            "size": "0",
            "childItemsCount": "0"
        }
    ]
}

例4

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

GET .../folders/F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518/items?orderby=name:asc&limit=2&offset=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 403

JSONレスポンス

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

例5

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

GET .../folders/F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518/items?orderby=name:asc&limit=2&offset=1

リクエスト・ヘッダー

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": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518",
    "isCombined": "1",
    "limit": "2",
    "offset": "1",
    "title": "The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例6

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

GET .../folders/FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518/items?orderby=name:asc&limit=2&offset=1

リクエスト・ヘッダー

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

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "childItemsCount": "1",
    "count": "0",
    "createdBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "createdTime": "2017-06-14T20:49:08Z",
    "description": "appLinkTest",
    "errorCode": "0",
    "hasMore": "0",
    "id": "FAD7A87F0613A0CBDD4DA521B5D17B95F47087F4E518",
    "limit": "2",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-16T17:16:28Z",
    "name": "appLinkTest",
    "offset": "1",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "size": "0",
    "totalResults": "1",
    "type": "folder"
}
先頭に戻る