有効なすべてのユーザーのリストを取得
get
/social/api/v1/people
リクエスト
サポートされているメディア・タイプ
- application/json
問合せ対象のフィルタを指定します。
ルート・スキーマ: XV1PeopleFilterInfo
型:
objectV1人フィルタ情報。
Show Source
- excludeHidden(optional): boolean
非表示ユーザーを除外するにはTrueを設定します。
- isDisabled(optional): boolean
無効なユーザーを返します。 isEnabledとisDisabledの両方がfalseである場合、有効なユーザーのみが返されます。
- isEnabled(optional): boolean
有効なユーザーを返します。 isEnabledとisDisabledの両方がfalseである場合、有効なユーザーのみが返されます。
- startsWith(optional): string
名前の接頭辞。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ: XV1PeopleListInfo
型:
objectV1人リスト情報DTO。
Show Source
- hasMore(optional): boolean
trueの場合、他にも返すアイテムが存在します。
- items(optional): array items
返される人。
- nextURL(optional): string(url)
リストの次のページのURL。 これが最後のページである場合はNull。
- previousURL(optional): string(url)
リストの前のページのURL。 これが最初のページである場合はNull。
- total(optional): integer(int32)
指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。
ネストされたスキーマ: XV1PeopleInfo
型:
objectV1人情報DTO。
Show Source
- addressBuilding(optional): string
このユーザー・ビルディング。
- addressCity(optional): string
このユーザー都市。
- addressCountry(optional): string
このユーザー国。
- addressLine1(optional): string
このユーザーの番地は1行目です。
- addressLine2(optional): string
このユーザーの番地は2行目です。
- addressOffice(optional): string
このユーザー・オフィス。
- addressState(optional): string
このユーザー状態。
- addressZipCode(optional): string
このユーザーの郵便番号。
- altitude(optional): number(double)
オブジェクトの高度。
- biography(optional): string
このユーザーの履歴。
- chatURL(optional): string(url)
このユーザーの、現在のユーザーとの1対1の会話を指定するURL。
- collectionURL(optional): string(url)
コレクションを含むこのオブジェクトのURLです。
- company(optional): string
このユーザーの会社。
- conversationURL(optional): string(url)
このオブジェクトに含まれる会話へのURL。
- costCenter(optional): string
このユーザーのコスト・センター。
- createdByID(optional):
オブジェクトのlong integer表現の一意識別子。
- createdByURL(optional): string(url)
このオブジェクトを作成したユーザーへのURL。
- createdByUserDisplayName(optional): string
このオブジェクトを作成したユーザーの表示名。
- createdByUserName(optional): string
このオブジェクトを作成したユーザーの名前。
- createdDate(optional): string(date)
このオブジェクトが作成された日付。
- createdDateInISO8601Format(optional): string
このオブジェクトが作成された日付(ISO 8601書式)。
- dateFormatLocale(optional): string(uuid)
日付の書式を設定するための、このユーザーのロケール。
- description(optional): string
ユーザー・プロファイルの説明。
- displayName(optional): string
このオブジェクトの表示名。
- eMailAddress(optional): string
このユーザーの電子メール・アドレス。
- expertise(optional): string
このユーザーの専門知識。
- followersURL(optional): string(url)
このユーザーのフォロワのURL。 このユーザーのフォロワであるユーザー。
- followingURL(optional): string(url)
このユーザーがフォローしているURL。 このユーザーがフォローしているユーザー。
- fullName(optional): string
このユーザーのフルネーム。
- id(optional):
オブジェクトのlong integer表現の一意識別子。
- interests(optional): string
このユーザーの興味。
- isDeleted(optional): boolean
このユーザーが削除された場合はTrue。
- isEnabled(optional): boolean
このユーザーが有効な場合はTrue。
- isExternalUser(optional): boolean
ユーザーが外部ユーザーであれば真。
- isHidden(optional): boolean
ユーザーが非表示になる場合はTrue。
- isIntegrationUser(optional): boolean
ユーザーが統合ユーザーである場合はTrue。
- isInternal(optional): boolean
内部ユーザーの場合はTrue、外部ユーザーの場合はfalse。
- isOutsider(optional): boolean
ユーザーが部外者である場合はTrue。
- isRemoved(optional): boolean
このメッセージが削除された場合はTrue。
- languageLocale(optional): string(uuid)
このユーザーの言語ロケール。
- lastConnectedDate(optional): string(date)
このユーザーが最後に接続した日付。
- lastConnectedDateInISO8601Format(optional): string
このユーザーが最後に接続した日付(ISO 8601書式)。
- lastDisconnectedDate(optional): string(date)
このユーザーが最後に切断した日付。
- lastDisconnectedDateInISO8601Format(optional): string
このユーザーが最後に切断した日付(ISO 8601書式)。
- latitude(optional): number(double)
オブジェクトの緯度。
- libraryURL(optional): string(url)
このユーザーのライブラリを指定するURL。
- link(optional): string
このユーザーがウォールまたはプロファイルに表示しているリンクがある場合は、そのURL。
- location(optional): string
このユーザーのロケーション。
- longitude(optional): number(double)
オブジェクトの経度。
- modifiedByID(optional):
オブジェクトのlong integer表現の一意識別子。
- modifiedByURL(optional): string(url)
このオブジェクトを最後に変更したユーザーへのURL。
- modifiedByUserDisplayName(optional): string
このオブジェクトを最後に変更したユーザーの表示名。
- modifiedByUserName(optional): string
このオブジェクトを最後に変更したユーザーの名前。
- modifiedDate(optional): string(date)
このオブジェクトが最後に変更された日付。
- modifiedDateInISO8601Format(optional): string
このオブジェクトが最後に変更された日付(ISO 8601書式)。
- name(optional): string
このオブジェクトの名前。
- objectType(optional): string
このオブジェクトのタイプ。
- organization(optional): string
このユーザーの組織。
- originalPictureURL(optional): string(url)
元のピクチャのURL。
- profilePictureURL(optional): string(url)
プロファイル・ピクチャのURL (150×150ピクセル)。
- propertiesURL(optional): string(url)
このユーザーのプロパティのURL。
- removedByID(optional):
オブジェクトのlong integer表現の一意識別子。
- removedByURL(optional): string(url)
このオブジェクトを最後に削除したユーザーへのURL。
- removedByUserDisplayName(optional): string
このオブジェクトを最後に削除したユーザーの表示名。
- removedByUserName(optional): string
このオブジェクトを最後に削除したユーザーの名前。
- removedDate(optional): string(date)
このオブジェクトが削除された日付。
- removedDateInISO8601Format(optional): string
このオブジェクトが削除された日付(ISO 8601書式)。
- scaledPictureURL(optional): string(url)
スケール調整済ピクチャのURL (44×44ピクセル)。
- socialObjectURL(optional): string(url)
このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
- socialObjectViewID(optional): string
ユーザーの現在のコラボレーション・オブジェクト・ビューID(nullでもかまいません)。
- statisticsURL(optional): string(url)
このユーザーの統計を取得するためのURL。
- timeZone(optional): string(uuid)
このユーザーのタイムゾーン。
- title(optional): string
このユーザーの役職。
- url(optional): string(url)
このオブジェクトへのURL。
- wallURL(optional): string(url)
このユーザーのウォールを指定するURL。