機械翻訳について

移動先

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

ユーザーの取得

get

/documents/api/1.2/users/items

フォルダおよびファイル共有の目的で、1つ以上のユーザーについて情報を取得します。

サービスはコールで指定された検索テキストを使用して、想定されるユーザーを照合します。 この検索ではユーザー名と電子メール・アドレスの「あいまい」検索を使用して、最も一致する可能性の高い順に一致するユーザーを返します。

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• info: string

  (必須)一致するユーザーを戻すために使用する検索文字列を指定します。 ワイルドカード文字がサポートされていないため、空のパラメータ値は欠落したパラメータとして扱われます。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

一致するユーザーがない場合、countとerrorCodeは"0"になり、アイテムは返されません。

本文 ()

ルート・スキーマ: UsersResponse

タイプ: object

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

ソースを表示

• count(optional): string
  見つかったユーザーの数。
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• items(optional): array items
  アイテムの最少数: 0

{
    "description":"Folder metadata information.",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of users found."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/User"
            },
            "minItems":0
        }
    }
}

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

タイプ: array

アイテムの最少数: 0

ソースを表示

• Array of: object User
  ユーザー情報

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/User"
    },
    "minItems":0
}

ネストされたスキーマ: 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",
    "errorCode":"0",
    "items":[
        {
            "id":"U0EAA20910FAF3052ACB79E4T00000000001",
            "displayName":"User AA",
            "loginName":"userAALoginName",
            "type":"user"
        },
        {
            "id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
            "displayName":"User BB",
            "loginName":"userBBLoginName",
            "type":"user"
        },
        {
            "id":"UEB4B3EFA6C02D1B46A121B4T00000000001",
            "displayName":"User CC",
            "loginName":"userCCLoginName",
            "type":"user"
        }
    ]
}

400レスポンス

必須フィールド"info"が指定されていません。

トップに戻る

例

次の例では、指定された文字列が名前に含まれているユーザーのユーザー情報が返されます。

GET .../users/items?info=user%20A

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
    "count": "3",
    "errorCode": "0",
    "items": [
        {
            "type": "user",
            "id": "U0EAA20910FAF3052ACB79E4T00000000001",
            "displayName": "User AA",
            "loginName": "userAALoginName"
        },
        {
            "type": "user",
            "id": "U7ECC74059E0FEDFEC66BF5AT00000000001",
            "displayName": "User BB",
            "loginName": "userBBLoginName"
        },
        {
            "type": "user",
            "id": "UEB4B3EFA6C02D1B46A121B4T00000000001",
            "displayName": "User CC",
            "loginName": "userCCLoginName"
        }
    ]
}

先頭に戻る