機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

ホーム・フォルダ・コンテンツの取得

get

/documents/api/1.2/folders/items

他のユーザーが共有しているフォルダも含め、ユーザーがアクセスできるすべてのアイテム(フォルダおよびファイル)のコレクションを取得します。 typeフィールドは、アイテムがフォルダかファイルかを示します。

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• limit(オプション): 文字列

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

  limit=10

• offset(オプション): string

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

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

  limit=10&offset=10

• orderby(optional): string

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

  orderby=name:asc

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ: HomeFolderContents

タイプ: object

ソースを表示

• count(optional): string
  ページにリストされるアイテムの数
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• hasMore(optional): string
  見つかったユーザーの数。
• items(optional): array items
  フォルダ内のファイルおよびサブフォルダ。
• ownerFolderID(optional): string

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

• totalResults(optional): string
  レスポンスに含まれるアイテムの総数

{
    "description":"",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of items listed on the page."
        },
        "totalResults":{
            "type":"string",
            "description":"Total number of items in the response."
        },
        "ownerFolderID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the folder. If the referenced folder is the user&#39;s home folder, the value is <code>self</code>.</p>"
        },
        "hasMore":{
            "type":"string",
            "description":"The number of users found."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "description":"The files and subfolders in the folder.",
            "items":{
                "$ref":"#/definitions/FileAndSubFoldersItemsDefinition"
            }
        }
    }
}

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

タイプ: array

フォルダ内のファイルおよびサブフォルダ。

ソースを表示

• Array of: object FileAndSubFoldersItemsDefinition
  フォルダ内のファイルおよびサブフォルダ。

{
    "type":"array",
    "description":"The files and subfolders in the folder.",
    "items":{
        "$ref":"#/definitions/FileAndSubFoldersItemsDefinition"
    }
}

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

タイプ: object

フォルダ内のファイルおよびサブフォルダ。

ソースを表示

• childItemsCount(optional): string
  フォルダに含まれるアイテムの数
• createdBy(optional): object User
  ユーザー情報
• createdTime(optional): string
  フォルダまたはファイルの作成日。
• id(optional): string
  フォルダまたはファイルのグローバル一意識別子(GUID)
• 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またはfileです。
• version(optional): string
  アイテムがファイルの場合は、ファイルのバージョン数。

{
    "description":"The files and subfolders in the folder.",
    "properties":{
        "type":{
            "type":"string",
            "description":"Item type, either <code>folder</code> or <code>file</code>."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder or file."
        },
        "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 or file name."
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "createdTime":{
            "type":"string",
            "description":"Folder or file creation date."
        },
        "modifiedTime":{
            "type":"string",
            "description":"Folder or file last modified date."
        },
        "size":{
            "type":"string",
            "description":"<p>If the item is a file, the size of the file in bytes. If the item is a folder, then the size of the folder including all of the files and sub folders contained in the folder.</p>"
        },
        "childItemsCount":{
            "type":"string",
            "description":"Number of items contained in the folder."
        },
        "version":{
            "type":"string",
            "description":"If the item is a file, the number of versions of the file."
        }
    }
}

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

{
    "count":"3",
    "totalResults":"3",
    "ownerFolderID":"self",
    "hasMore":"0",
    "errorCode":"0",
    "items":[
        {
            "id":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "parentID":"self",
            "name":"foldera",
            "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"
            }
        },
        {
            "id":"F4A669A2B7B69F2376C640A9T0000000000100000001",
            "parentID":"self",
            "name":"folderb",
            "type":"folder",
            "size":"0",
            "childItemsCount":"0",
            "createdTime":"2014-02-21T21:38:44Z",
            "modifiedTime":"2014-02-21T21:38:44Z",
            "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":"DBFDB0B6543FB5B68107423AT0000000000100000001",
            "parentID":"self",
            "name":"test cases.txt",
            "type":"file",
            "size":"37786",
            "version":"1",
            "createdTime":"2014-02-21T21:38:52Z",
            "modifiedTime":"2014-02-21T21:38:52Z",
            "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/items?orderby=name:asc&limit=10&offset=10

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "3",
    "errorCode": "0",
    "hasMore": "0",
    "ownerFolderID": "self",
    "totalResults": "3",
    "items": [
        {
            "type": "folder",
            "id": "FF4729683CD68C1AFB1AE87DT0000000000100000001",
            "parentID": "self",
            "name": "foldera",
            "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:52:37Z",
            "modifiedTime": "2014-02-21T20:52:37Z",
            "size": "39",
            "childItemsCount": "2"
        },
        {
            "type": "folder",
            "id": "F4A669A2B7B69F2376C640A9T0000000000100000001",
            "parentID": "self",
            "name": "folderb",
            "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:38:44Z",
            "modifiedTime": "2014-02-21T21:38:44Z",
            "description": "folder b",
            "size": "0",
            "childItemsCount": "0"
        },
        {
            "type": "file",
            "id": "DBFDB0B6543FB5B68107423AT0000000000100000001",
            "parentID": "self",
            "name": "test cases.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:38:52Z",
            "modifiedTime": "2014-02-21T21:38:52Z",
            "size": "37786",
            "version": "1"
        }
    ]
}

先頭に戻る