新規接続を作成する、または既存の接続が存在するかどうかを確認 空の名前とパスワードとともに使用して、ランダムIDを取得することもできます。
post
/social/api/v1/connections
リクエスト
サポートされているメディア・タイプ
- application/json
リクエスト本文は、リクエストの詳細を定義します。
ルート・スキーマ: XV1ConnectionCreateInfo
型:
objectV1接続作成情報。
ソースを表示
- enterHive(optional): boolean
trueに設定されている場合は、ログイン時にハイブを入力します。
- name(optional): string
ユーザー名。 名前とパスワードはいずれもオプションです。 新規接続を作成するには両方が必要になります。 APIRandomID値を取得するリクエストを行う場合は、両方を省略する必要があります。
- password(optional): string
ユーザー・パスワード。 名前とパスワードはいずれもオプションです。 新規接続を作成するには両方が必要になります。 APIRandomID値を取得するリクエストを行う場合は、両方を省略する必要があります。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ: XV1ConnectionInfo
型:
objectV1会話プロパティ情報DTO。
ソースを表示
- analyticsURL(optional): string
分析URL。
- apiRandomID(optional): string
すべてのAPIリクエストとともにヘッダー'X-Waggle-RandomID'に含めて送信する必要があるランダムID。
- apiVersion(optional): integer(int32)
サーバーによって受け入れられたAPIの現在のAPIバージョン。
- apiVersionMinimum(optional): integer(int32)
サーバーで受け入れられるAPIの最小APIバージョン。
- backChannelHost(optional): string
バック・チャネル・アクセス・ホスト。
- backChannelPath(optional): string
バック・チャネル・アクセス・パス。
- backChannelServletName(optional): string
バック・チャネル・アクセス・サーブレット名。
- backChannelURL(optional): string
バック・チャネル・アクセスURL。
- clientAdminURL(optional): string
クライアント管理URL。
- clientDownloadURL(optional): string
Outlookまたはデスクトップ・クライアントのダウンロードURL。
- clientDownloadURL_Android(optional): string
Androidクライアント・ダウンロードURL。
- clientDownloadURL_Desktop(optional): string
デスクトップ・クライアント・ダウンロードURL。
- clientDownloadURL_iOS(optional): string
iOSクライアント・ダウンロードURL。
- clientDownloadURL_Outlook(optional): string
Outlookクライアント・ダウンロードURL。
- clientHelpURL(optional): string
クライアント・ヘルプURL。
- clientUpdateURL(optional): string
Outlookまたはデスクトップ・クライアントの更新URL。
- clientUpdateURL_Desktop(optional): string
デスクトップ・クライアント更新URL。
- clientUpdateURL_Outlook(optional): string
Outlookクライアント更新URL。
- communityURL(optional): string
コミュニティURL。
- contextName(optional): string
フロント・チャネルまたはバック・チャネルのアクセス・コンテキスト名。
- contextURL(optional): string
フロント・チャネルまたはバック・チャネルのアクセス・コンテキストのベースURL。
- dateFormatLocale(optional): string
ユーザーの日付の書式を設定するためにクライアントが使用するロケール。 このロケールは、ユーザーのプロフィール、HTTP accept-languageヘッダー、アプリケーション構成、ホスト・マシン設定、および使用可能な翻訳バンドルに基づいて、サーバーによって推定されます。 日付書式では、翻訳バンドルのロケールと同じプライマリ言語が使用されますが、正式にサポートされている翻訳の1つと完全に一致しない場合があります。 これは、翻訳バンドルのロケールが単に'en'である場合に、'en_US'や'en_GB'などの、より特化した日付書式ロケールが許可されるためです。
- externalMobileClientURL(optional): string
外部モバイル・クライアントURL。
- externalWebClientURL(optional): string
外部WebクライアントURL。
- federatedSSOApplicationName(optional): string
モバイル・クライアント・フェデレーテッドSSOアプリケーション名。
- federatedSSOEnabled(optional): boolean
モバイル・クライアント・フェデレーテッドSSO使用可能ステータス。
- federatedSSOLoginFailureURL(optional): string
モバイル・クライアント・フェデレーテッドSSOログイン失敗URL。
- federatedSSOLoginSuccessURL(optional): string
モバイル・クライアント・フェデレーテッドSSOログイン成功URL。
- federatedSSOLoginURL(optional): string
モバイル・クライアント・フェデレーテッドSSOログインURL。
- federatedSSOLogoutURL(optional): string
モバイル・クライアント・フェデレーテッドSSOログアウトURL。
- federatedSSORequiredTokens(optional): string
モバイル・クライアント・トークン。
- flagAllLimitHard(optional): integer(int32)
すべてのユーザーに強い制限を示すフラグを設定します。
- flagAllLimitSoft(optional): integer(int32)
すべてのユーザーに弱い制限のフラグを付けます。
- frontChannelHost(optional): string
フロント・チャネル・アクセス・ホスト。
- frontChannelPath(optional): string
フロント・チャネル・アクセス・パス。
- frontChannelServletName(optional): string
フロント・チャネル・アクセス・サーブレット名。
- frontChannelURL(optional): string
フロント・チャネル・アクセスURL。
- hiveGUID(optional): string
hive GUID。すべてのインスタンスで一意です。
- hiveHash(optional): string
ハイブ・ハッシュ。すべてのインスタンスで一意です。 これはhiveGUIDの最初の4文字です。
- isAppAuthor(optional): boolean
ユーザーのアプリ作成者ステータスです。
- isCommunitiesEnabled(optional): boolean
コミュニティが有効であれば真。
- isCommunityAdmin(optional): boolean
ユーザーのコミュニティ管理ステータス。
- isContentSearchEnabled(optional): boolean
検索が有効な場合はTrue。
- isMaximumFileSizeEnabled(optional): boolean
部分(ファイル)当たりの最大サイズの有効ステータス。 この値がfalseである場合、制限はありません。
- isMaximumRequestSizeEnabled(optional): boolean
リクエスト合計の最大サイズの有効ステータス。 この値がfalseである場合、制限はありません。
- isOutsider(optional): boolean
ユーザーの外部者ステータス。
- isSiteAdmin(optional): boolean
ユーザーのサイト管理ステータス。
- isTenantAdmin(optional): boolean
ユーザーのサービス(以前はテナントと呼ばれていました)管理ステータス。
- isTerseMode(optional): boolean
APIリクエストに対して簡潔レスポンスが有効な場合はTrue。 (有効な場合、booleanの'false'あるいはintegerまたはlongの'zero'の値が含まれるフィールドは、レスポンスに含まれません。)
- iteration(optional): string
開発の反復。
- languageLocale(optional): string
推奨される言語翻訳バンドルのロケール。 翻訳バンドルのロケールは、ユーザーのプロフィール、HTTP accept-languageヘッダー、サーバー・アプリケーション構成、ホスト・マシン設定、および使用可能な翻訳バンドルに基づいて、サーバーによって推定されます。 クライアントがこのロケールを使用してユーザーに表示する翻訳バンドルを選択することを意図しています。 ロケールは、正式にサポートされている翻訳の1つと完全に一致するため、クライアントが独自のフォールバック・アルゴリズムを実装する必要はありません。
- logoImage(optional): string
ロゴ・イメージ。 nullも可。
- logoText(optional): string
ロゴ・テキスト。 nullも可。
- logoutURL(optional): string
ログアウト・プロセスを完了するために、ユーザーがログアウトした後にリダイレクトされるURL。通常はSSO統合で使用されます。 このステップが不要な場合は、NULLにできます。
- mailHost(optional): string
クライアントが使用可能なメール・ホスト。
- maximumChatSize(optional): integer(int64)
チャット合計の最大サイズ(バイト)。
- maximumFileSize(optional): integer(int64)
部分(ファイル)当たりの最大サイズ(バイト)。
- maximumRequestsInBatch(optional): integer(int64)
バッチ内の最大リクエスト数。
- maximumRequestSize(optional): integer(int64)
リクエスト合計の最大サイズ(バイト)。
- numEnteredClients(optional): integer(int32)
ログイン時にenterHiveが有効な場合、セッションに入力したクライアントの番号。
- platformURL(optional): string
開発者サイト(旧プラットフォーム) URL。
- presenceIdleMS(optional): integer(int64)
予期されるクライアント・プレゼンス・アイドル・タイムアウト(ミリ秒)。
- pushEnabled(optional): array pushEnabled
現在どのプッシュ・デバイスが有効になっているかを判定します。
- revisionCommitID(optional): string
リビジョン・コミットID (ハッシュ)または'no-commitid'。
- revisionDate(optional): string
リビジョン日(ISO 8601書式)または'no-date'。
- revisionTag(optional): string
リビジョン・タグまたは'no-tag'。
- serverDate(optional): string(date)
サーバーの日付。 サーバーから送信された日付をローカル時間に同期するのに役立ちます。
- serverDateInISO8601Format(optional): string
サーバーの日付。 サーバーから送信された日付をローカル時間(ISO 8601書式)に同期するのに役立ちます。
- serverHosts(optional): array serverHosts
すべてのサーバー・アクセス・ホストのリスト。
- serverMethod(optional): string
サーバーのアクセス方法。
- serverPort(optional): integer(int32)
サーバーのアクセス・ポート。
- socialChannelHost(optional): string
Collaborationのチャネル・アクセス・ホスト。
- socialChannelPath(optional): string
Collaborationのチャネル・アクセス・パス。
- socialChannelServletName(optional): string
Collaborationのチャネル・アクセス・サーブレット名。
- socialChannelURL(optional): string
Collaborationのチャネル・アクセスURL。
- supportDescription(optional): string
サポートの説明。
- themeColor(optional): string
テーマ・カラー。
- user(optional): object XV1PeopleInfo
V1人情報DTO。
- version(optional): string
リリース・バージョンの完全文字列。
ネストされたスキーマ: serverHosts
型:
arrayすべてのサーバー・アクセス・ホストのリスト。
ソースを表示
- Array of: string
すべてのサーバー・アクセス・ホストのリスト。
ネストされたスキーマ: XV1PeopleInfo
型:
objectV1人情報DTO。
ソースを表示
- 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(オプション): boolean
このユーザーが削除された場合はTrue。
- isEnabled(optional): boolean
このユーザーが有効な場合はTrue。
- 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。
ネストされたスキーマ: XDeviceType
型:
ソースを表示
object- field(optional): string
許容値:
[ "APNS", "EMAIL", "GCM", "SMS", "TXT" ]デバイス・タイプ。