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

フォルダまたはファイルの検索

get

/documents/api/1.2/folders/search/items

ユーザーのホーム・ディレクトリで、fulltextまたはquerytextでフォルダまたはファイルを検索します。 ホーム・ディレクトリの下のディレクトリ・ツリー全体を検索します。 共有フォルダも検索します。 検索には、10000アイテム(フォルダおよびファイル)の制限があります。

リクエスト

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

  • 返される追加フィールドを指定します。 現在サポートされている値はmetadataのみで、検索結果によって返されるアイテムに関連付けられたメタデータがレスポンスに追加されます。 デフォルトでは、検索結果にメタデータは返されません。 メタデータを返すには、次を使用 

    fields=metadata

  • フォルダまたはファイルの一致に使用される検索文字列。 次の場所を検索します: itemName、contents、extension、ownerName、lastModifiedName,およびfolderDescription。

    検索APIにfulltextまたはquerytextを指定する必要があります。

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

    limit=10

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

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

    limit=10&offset=10

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

    orderby=name:asc

  • 下記のターゲットを使用してフォルダまたはファイルを検索するための検索文字列。 同時に複数のターゲットを利用して、fulltextを置き換えることができます。

    検索APIには、fulltextまたはquerytextパラメータを指定する必要があります。

    querytextパラメータは、次の文字列フィールドまたは番号フィールドに対して検索を対象とすることができます。 検索問合せの形式は次のとおりです: 

    searchField<operation>searchValue

    複数の検索を<AND>および<OR>と組み合わせることができます。 検索では大文字と小文字は区別されません。


    次の文字列フィールドがサポートされています:
    • xTags: タグを検索
    • fItemType: アイテム・タイプのみで検索するか、Fileでファイル・アイテムのみを返すか、Folderでフォルダ・アイテムのみを返す。
    • fItemName: アイテムの名前を検索します。
      レスポンスでは、これはnameフィールドです。
    • fCreator: アイテムの作成者のIDで検索します。
      レスポンスでは、これはcreatedBy.idフィールドです。
    • fCreatorFullName: アイテムの作成者の完全な表示名で検索します。
      レスポンスでは、これはcreatedBy.displayNameフィールドです。
    • fCreatorLoginName: アイテムの作成者のログイン名で検索します。
      レスポンスでは、これはcreatedBy.loginNameフィールドです。
    • fOwner: 品目の所有者のIDで検索します。
      レスポンスでは、これはownedBy.idフィールドです。
    • fOwnerFullName: 品目の所有者の完全な表示名で検索します。
      レスポンスでは、これはownedBy.displayNameフィールドです。
    • fOwnerLoginName: アイテムの所有者のログイン名で検索します。
      レスポンスでは、これはownedBy.loginNameフィールドです。
    • fLastModifier: ユーザーのIDで検索してアイテムを最後に変更します。
      レスポンスでは、これはmodifiedBy.idフィールドです。
    • fLastModifierFullName: アイテムを最後に変更するユーザーの完全な表示名で検索します。
      レスポンスでは、これはmodifiedBy.displayNameフィールドです。
    • fLastModifierLoginName: ユーザーのログイン名で検索し、最後にアイテムを変更します。
      レスポンスでは、これはmodifiedBy.loginNameフィールドです。
    • 検索可能なメタデータ・フィールドは、文字列検索ターゲットとしても検索できますが、メタデータ・フィールド値は検索によって戻されません。 メタデータ・フィールドで検索すると、ターゲットはMetadataCollectionName.metadataFieldNameになります。 メタデータの詳細については、「メタデータ・コレクションRESTエンドポイント」を参照してください

    文字列検索では、<CONTAINS>および<MATCHES>の操作がサポートされます。

    • <CONTAINS>演算子は、指定されたワードを含む検索対象のテキスト・フィールドを検索するように検索に指示します。 単語は、空白やピリオドなどのトークンで区切る必要があります。
    • <MATCHES>演算子は、空白やピリオドなど、フィールド値の完全一致(大/小文字を区別しない)を検索するように検索に指示します。


    次の日付フィールドがサポートされています:
    • fCreateDate: 作成されたタイムスタンプで検索します。 yyyy-mm-ddThh:mm:ssZ形式(2020-03-25T10:10:10Zなど)である必要があります。
      レスポンスでは、これはcreatedTimeフィールドです。
    • fLastModifiedDate: 最終変更タイムスタンプで検索します。 yyyy-mm-ddThh:mm:ssZ形式(2020-03-25T10:10:10Zなど)である必要があります。
      レスポンスでは、これはmodifiedTimeフィールドです。
    • 検索可能なメタデータ・フィールドを日付検索ターゲットとして検索することもできますが、メタデータ・フィールド値は検索で返されません。 メタデータ・フィールドで検索すると、ターゲットはMetadataCollectionName.metadataFieldNameになります。 メタデータの詳細については、「メタデータ・コレクションRESTエンドポイント」を参照してください

    次の番号フィールドがサポートされています:
    • dSize: アイテムのバイト単位のサイズで検索します。

    数値および日付の検索ターゲットでは、次の操作がサポートされます。

    • <を使用して、検索値より小さい値を検索します。< span>
    • =を使用して、検索値と等しい値を検索します。
    • >を使用して、検索値より大きい値を検索します。
    • 検索値以下の値を検索するには、& lt =を使用します。
    • >=を使用して、検索値以上の値を検索します。

トップに戻る

レスポンス

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

200レスポンス

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

本文 ()
ルート・スキーマ: SearchFolderContents
タイプ: object
ソースを表示
ネストされたスキーマ: items
タイプ: array
検索によって返されたフォルダとファイル。
ソースを表示
ネストされたスキーマ : FileAndSubFoldersItemsDefinition
タイプ: object
フォルダ内のファイルおよびサブフォルダ。
ソースを表示
ネストされたスキーマ: User
タイプ: object
ユーザー情報
ソースを表示
レスポンスの例(application/json)
{
    "count":"2",
    "errorCode":"0",
    "offset":"1",
    "totalCount":"3",
    "items":[
        {
            "type":"folder",
            "id":"FF4321BD2656077C897A0E701212FF6185DE5A6F9E67",
            "name":"three",
            "parentID":"self",
            "createdTime":"2015-12-09T20:51:53Z",
            "modifiedTime":"2015-12-09T20:51:53Z",
            "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"
            },
            "metadata":{
                "items":[
                    {
                        "name":"MyMetaCollection",
                        "fields":{
                            "items":[
                                {
                                    "name":"IntField",
                                    "type":"integer",
                                    "value":"12345"
                                },
                                {
                                    "name":"DateField",
                                    "type":"date",
                                    "value":"2023-02-20T12:00:00.000Z"
                                }
                            ]
                        }
                    },
                    {
                        "name":"dDefaultFolderMetaCollection",
                        "fields":{
                            "items":[
                                {
                                    "name":"xTags",
                                    "type":"string",
                                    "value":"FixMe"
                                }
                            ]
                        }
                    }
                ]
            },
            "size":"-1"
        },
        {
            "type":"file",
            "id":"DB4C832D0F144C0DD6310F451212FF6185DE5A6F9E67",
            "name":"textData13.txt",
            "parentID":"F9363F588099E137C5B2939E1212FF6185DE5A6F9E67",
            "createdTime":"2015-12-07T23:19:13Z",
            "modifiedTime":"2015-12-07T23:19:13Z",
            "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"
            },
            "metadata":{
                "items":[
                ]
            },
            "size":"38",
            "version":"1"
        }
    ]
}

400レスポンス

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

トップに戻る

例

次の例では、ユーザーのホーム・ディレクトリ内のfulltextでフォルダまたはファイルを検索します。 ホーム・ディレクトリおよび共有フォルダの下のディレクトリ・ツリー全体を検索します。 

GET .../folders/search/items?fulltext=three&orderby=size:asc&limit=2&offset=1

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "2",
    "errorCode": "0",
    "offset": "1",
    "totalCount": "3",
    "items": [
        {
            "type": "folder",
            "id": "FF4321BD2656077C897A0E701212FF6185DE5A6F9E67",
		"name": "three",
            "parentID": "self",
            "createdTime": "2015-12-09T20:51:53Z",
            "modifiedTime": "2015-12-09T20:51:53Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "size": "-1"
        },
        {
            "type": "file",
            "id": "DB4C832D0F144C0DD6310F451212FF6185DE5A6F9E67",
            "name": "textData13.txt",
            "parentID": "F9363F588099E137C5B2939E1212FF6185DE5A6F9E67",
            "createdTime": "2015-12-07T23:19:13Z",
            "modifiedTime": "2015-12-07T23:19:13Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "size": "38",
            "version": "1"
        }
    ]
}

例2

次の例では、無効なorderbyソート・フィールドを使用してフォルダまたはファイルを検索します。 

GET .../folders/search/items?fulltext=three&orderby=date

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "count": "0",
    "errorCode": "-96",
    "errorKey": "!csUnableToRetrieveSearchResults!csCloudOTSSearchInvalidSortField",
    "errorMessage": "Unable to retrieve search results. SortField is not valid.",
    "title": "Unable to retrieve search results. SortField is not valid.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例3

次の例では、無効なorderbyソート順序を使用してフォルダまたはファイルを検索します。 

GET .../folders/search/items?fulltext=three&orderby=name:descending

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "count": "0",
    "errorCode": "-96",
    "errorKey": "!csUnableToRetrieveSearchResults!csSortOrderInvalid,descending",
    "errorMessage": "Unable to retrieve search results. Sort order 'descending' is invalid. Should be \"DESC\" or \"ASC\".",
}

例4

次の例では、fulltext検索基準のないフォルダまたはファイルを検索します。 

GET .../folders/search/items

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "count": "0",
    "errorCode": "-97",
    "errorKey": "!csUnableToRetrieveSearchResults!csSearchMissingQueryText",
    "errorMessage": "Unable to retrieve search results. QueryText is missing.",
    "title": "Unable to retrieve search results. QueryText is missing.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例5

次の例では、無効な限度を使用してフォルダまたはファイルを検索します。

GET .../folders/search/items?fulltext=test&orderby=size:asc&limit=0

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 400

JSONレスポンス

{
    "count": "0",
    "errorCode": "-1",
    "errorKey": "!csUnableToRetrieveSearchResults!csSearchItemNotPositive,ResultCount",
    "errorMessage": "Unable to retrieve search results. ResultCount must be greater than 0.",
    "title": "Unable to retrieve search results. ResultCount must be greater than 0.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

例6

次の例では、ユーザーのホーム・ディレクトリ内の特定のタグがあるフォルダまたはファイルを検索します。 ホーム・ディレクトリおよび共有フォルダの下のディレクトリ・ツリー全体を検索します。 タグ値は、%60で表される`のエンコードされた値で区切る必要があります。 

GET .../folders/search/items?querytext=xtags<CONTAINS>%60personal%60

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "2",
    "errorCode": "0",
    "offset": "0",
    "totalCount": "2",
    "items": [
        {
            "type": "folder",
            "id": "FF4321BD2656077C897A0E701212FF6185DE5A6F9E67",
			"name": "three",
            "parentID": "self",
            "createdTime": "2015-12-09T20:51:53Z",
            "modifiedTime": "2015-12-09T20:51:53Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "size": "-1"
        },
        {
            "type": "file",
            "id": "DB4C832D0F144C0DD6310F451212FF6185DE5A6F9E67",
            "name": "textData13.txt",
            "parentID": "F9363F588099E137C5B2939E1212FF6185DE5A6F9E67",
            "createdTime": "2015-12-07T23:19:13Z",
            "modifiedTime": "2015-12-07T23:19:13Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "size": "38",
            "version": "1"
        }
    ]
}

例7

次の例では、同時にテキスト・ファイル検索を使用して、ユーザーのホーム・ディレクトリ内の特定のタグがあるフォルダまたはファイルを検索します。 ホーム・ディレクトリおよび共有フォルダの下のディレクトリ・ツリー全体を検索します。 タグ値は、%60で表される`のエンコードされた値で区切る必要があります。 

GET .../folders/search/items?querytext=xtags<CONTAINS>%60personal%60<AND><ftx>txt</ftx>

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "1",
    "errorCode": "0",
    "offset": "0",
    "totalCount": "1",
    "items": [
        {
            "type": "file",
            "id": "DB4C832D0F144C0DD6310F451212FF6185DE5A6F9E67",
            "name": "textData13.txt",
            "parentID": "F9363F588099E137C5B2939E1212FF6185DE5A6F9E67",
            "createdTime": "2015-12-07T23:19:13Z",
            "modifiedTime": "2015-12-07T23:19:13Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
                "type": "user"
            },
            "size": "38",
            "version": "1"
        }
    ]
}

例8

次の例では、ユーザーのホーム・ディレクトリ内の特定のメタデータ値を持つフォルダまたはファイルを検索します。 ホーム・ディレクトリおよび共有フォルダの下のディレクトリ・ツリー全体を検索します。 メタデータ値は、%60で表される`の符号化された値によって区切られなければなりません。 

GET .../folders/search/items?querytext=SearchableCollection.searchField1<CONTAINS>%60searchValue1%60

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "5",
    "errorCode": "0",
    "offset": "0",
    "totalCount": "5",
    "items": [
        {
            "type": "folder",
            "id": "F454F4DE5EF397E880FFA186B5D17B95F47087F4E518",
            "name": "subFolder",
            "parentID": "FECEAA81A82C83700E64B43EB5D17B95F47087F4E518",
            "createdTime": "2016-10-10T13:54:09Z",
            "modifiedTime": "2016-10-10T13:54:09Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "size": "-1"
        },
        {
            "type": "file",
            "id": "D93A34CA721F82C77031708DB5D17B95F47087F4E518",
            "name": "file4.txt",
            "parentID": "FECEAA81A82C83700E64B43EB5D17B95F47087F4E518",
            "createdTime": "2016-09-21T14:08:54Z",
            "modifiedTime": "2016-09-21T14:08:54Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "size": "25",
            "version": "1"
        },
        {
            "type": "file",
            "id": "DCDBEBB4803B7EE48E4B073AB5D17B95F47087F4E518",
            "name": "file3.txt",
            "parentID": "FECEAA81A82C83700E64B43EB5D17B95F47087F4E518",
            "createdTime": "2016-09-21T14:08:13Z",
            "modifiedTime": "2016-09-21T14:08:13Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "size": "25",
            "version": "1"
        },
        {
            "type": "file",
            "id": "D8E8B2ABABAA0E42D3E4964CB5D17B95F47087F4E518",
            "name": "file2.txt",
            "parentID": "FECEAA81A82C83700E64B43EB5D17B95F47087F4E518",
            "createdTime": "2016-09-21T14:08:00Z",
            "modifiedTime": "2016-09-21T14:08:00Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "size": "25",
            "version": "1"
        },
        {
            "type": "file",
            "id": "D1A21D80F7FDD74E9FD93695B5D17B95F47087F4E518",
            "name": "file1.txt",
            "parentID": "FECEAA81A82C83700E64B43EB5D17B95F47087F4E518",
            "createdTime": "2016-09-21T14:07:06Z",
            "modifiedTime": "2016-09-21T14:07:06Z",
            "createdBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "ownedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "modifiedBy": {
                "displayName": "User AA",
                "loginName": "userAALoginName",
                "id": "U0EAA20910FAF3052ACB79E4T00000000001",
                "type": "user"
            },
            "size": "25",
            "version": "1"
        }
    ]
}
先頭に戻る