会話のためのREST API

機械翻訳について

既存の接続を更新

patch

/social/api/v1/connections

リクエスト

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

application/json

リクエスト本文は、リクエストの詳細を定義します。

ルート・スキーマ: XV1ConnectionUpdateInfo

型: object

V1接続更新情報。

ソースを表示

isImpersonate(optional): boolean

指定した名前を使用して偽装を設定または設定解除します。
isImpersonateEx(optional): boolean

指定した名前を使用して偽装を設定または設定解除します。フィールドrealmIDおよびsendInvitationも使用します。
isOnBehalfOf(optional): boolean

指定した名前を使用して代理操作を設定または設定解除します。
isOnBehalfOfEx(optional): boolean

指定した名前を使用して代理操作を設定または設定解除します。フィールドrealmIDおよびsendInvitationも使用します。
isTerseMode(optional): boolean

セッションのレスポンス・モード。簡潔モードでは、booleanの'false'あるいはintegerまたはlongの'zero'の値が含まれるフィールドは、レスポンスに含まれません。
name(optional): string

ユーザー名。
realmID(optional):

オブジェクトのlong integer表現の一意識別子。
sendInvitation(optional): boolean

ユーザー名の招待の送信オプション。 isOnBehalfOfExまたはisImpersonateExでのみ使用されます。

{
    "description":"V1 Connection Update Information.",
    "properties":{
        "isImpersonate":{
            "description":"Set or unset impersonate using the specified name.",
            "type":"boolean"
        },
        "isImpersonateEx":{
            "description":"Set or unset impersonate using the specified name. Also uses the  fields realmID and sendInvitation.",
            "type":"boolean"
        },
        "isOnBehalfOf":{
            "description":"Set or unset on-behalf-of using the specified name.",
            "type":"boolean"
        },
        "isOnBehalfOfEx":{
            "description":"Set or unset on-behalf-of using the specified name. Also uses the  fields realmID and sendInvitation.",
            "type":"boolean"
        },
        "isTerseMode":{
            "description":"The session's response mode. In terse mode, fields will not be  included in the response if they hold a boolean 'false' or an integer or long 'zero' value.",
            "type":"boolean"
        },
        "name":{
            "description":"The user name.",
            "type":"string"
        },
        "realmID":{
            "$ref":"#/definitions/XObjectID"
        },
        "sendInvitation":{
            "description":"The user name's send invitation option. Used for isOnBehalfOfEx or isImpersonateEx only.",
            "type":"boolean"
        }
    }
}

トップに戻る

レスポンス

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

application/json

200レスポンス

操作の成功

ルート・スキーマ: XV1ConnectionInfo

型: object

V1会話プロパティ情報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

リリース・バージョンの完全文字列。

{
    "description":"V1 Conversation Property Information DTO.",
    "properties":{
        "analyticsURL":{
            "description":"Analytics URL.",
            "type":"string"
        },
        "apiRandomID":{
            "description":"A random ID that should be sent along with all API requests in a header 'X-Waggle-RandomID'.",
            "type":"string"
        },
        "apiVersion":{
            "description":"The current API version of the API accepted by the server.",
            "type":"integer",
            "format":"int32"
        },
        "apiVersionMinimum":{
            "description":"The minimum API version of the API accepted by the server.",
            "type":"integer",
            "format":"int32"
        },
        "backChannelHost":{
            "description":"Back-channel access host.",
            "type":"string"
        },
        "backChannelPath":{
            "description":"Back-channel access path.",
            "type":"string"
        },
        "backChannelServletName":{
            "description":"Back-channel access servlet name.",
            "type":"string"
        },
        "backChannelURL":{
            "description":"Back-channel access URL.",
            "type":"string"
        },
        "clientAdminURL":{
            "description":"Client admin URL.",
            "type":"string"
        },
        "clientDownloadURL":{
            "description":"Outlook or Desktop Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_Android":{
            "description":"Android Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_Desktop":{
            "description":"Desktop Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_iOS":{
            "description":"iOS Client download URL.",
            "type":"string"
        },
        "clientDownloadURL_Outlook":{
            "description":"Outlook Client download URL.",
            "type":"string"
        },
        "clientHelpURL":{
            "description":"Client help URL.",
            "type":"string"
        },
        "clientUpdateURL":{
            "description":"Outlook or Desktop Client update URL.",
            "type":"string"
        },
        "clientUpdateURL_Desktop":{
            "description":"Desktop Client update URL.",
            "type":"string"
        },
        "clientUpdateURL_Outlook":{
            "description":"Outlook Client update URL.",
            "type":"string"
        },
        "communityURL":{
            "description":"The community URL.",
            "type":"string"
        },
        "contextName":{
            "description":"Front-channel or back-channel access context name.",
            "type":"string"
        },
        "contextURL":{
            "description":"Front-channel or back-channel access context base URL.",
            "type":"string"
        },
        "dateFormatLocale":{
            "description":"The locale that clients should use to format dates for the user. This locale is inferred  by the server based on the user's profile, the HTTP accept-language header, the application  configuration, the host machine setting, and the available translation bundles.  The date-format  locale will have the same primary language as the Translation Bundle locale, but might not  be an exact match of one of the officially supported translations. The reason for this is to  allow more specialized date-format locales, such as 'en_US' or 'en_GB', when the Translation Bundle  locale is simply 'en'.",
            "type":"string"
        },
        "externalMobileClientURL":{
            "description":"External Mobile Client URL.",
            "type":"string"
        },
        "externalWebClientURL":{
            "description":"External Web Client URL.",
            "type":"string"
        },
        "federatedSSOApplicationName":{
            "description":"Mobile Client Federated SSO Application Name.",
            "type":"string"
        },
        "federatedSSOEnabled":{
            "description":"Mobile Client Federated SSO enabled status.",
            "type":"boolean"
        },
        "federatedSSOLoginFailureURL":{
            "description":"Mobile Client Federated SSO Login Failure URL.",
            "type":"string"
        },
        "federatedSSOLoginSuccessURL":{
            "description":"Mobile Client Federated SSO Login Success URL.",
            "type":"string"
        },
        "federatedSSOLoginURL":{
            "description":"Mobile Client Federated SSO Login URL.",
            "type":"string"
        },
        "federatedSSOLogoutURL":{
            "description":"Mobile Client Federated SSO Logout URL.",
            "type":"string"
        },
        "federatedSSORequiredTokens":{
            "description":"Mobile Client Tokens.",
            "type":"string"
        },
        "flagAllLimitHard":{
            "description":"Flag all users hard limit.",
            "type":"integer",
            "format":"int32"
        },
        "flagAllLimitSoft":{
            "description":"Flag all users soft limit.",
            "type":"integer",
            "format":"int32"
        },
        "frontChannelHost":{
            "description":"Front-channel access host.",
            "type":"string"
        },
        "frontChannelPath":{
            "description":"Front-channel access path.",
            "type":"string"
        },
        "frontChannelServletName":{
            "description":"Front-channel access servlet name.",
            "type":"string"
        },
        "frontChannelURL":{
            "description":"Front-channel access URL.",
            "type":"string"
        },
        "hiveGUID":{
            "description":"The hive GUID, which is unique across all instances.",
            "type":"string"
        },
        "hiveHash":{
            "description":"The hive hash, which is unique across all instances. This is the first 4 characters of the hiveGUID.",
            "type":"string"
        },
        "isAppAuthor":{
            "description":"The user's app author status.",
            "type":"boolean"
        },
        "isCommunitiesEnabled":{
            "description":"True if communities are enabled.",
            "type":"boolean"
        },
        "isCommunityAdmin":{
            "description":"The user's community admin status.",
            "type":"boolean"
        },
        "isContentSearchEnabled":{
            "description":"True if content search is enabled.",
            "type":"boolean"
        },
        "isMaximumFileSizeEnabled":{
            "description":"Maximum per part (file) size enabled status. If the value is false, there is no limit.",
            "type":"boolean"
        },
        "isMaximumRequestSizeEnabled":{
            "description":"Maximum total request size enabled status. If the value is false, there is no limit.",
            "type":"boolean"
        },
        "isOutsider":{
            "description":"The user's outsider status.",
            "type":"boolean"
        },
        "isSiteAdmin":{
            "description":"The user's site admin status.",
            "type":"boolean"
        },
        "isTenantAdmin":{
            "description":"The user's service (previously called tenant) admin status.",
            "type":"boolean"
        },
        "isTerseMode":{
            "description":"True if terse responses are enabled for API requests. (If enabled, fields will not be  included in the response if they hold a boolean 'false' or an integer or long 'zero' value.)",
            "type":"boolean"
        },
        "iteration":{
            "description":"The development iteration.",
            "type":"string"
        },
        "languageLocale":{
            "description":"The locale of the recommended language translation bundle. The translation bundle locale  is inferred by the server based on the user's profile, the HTTP accept-language header, the  server application configuration, the host machine setting, and the available translation  bundles. The intent is for clients to use this locale for selecting the translation bundle  to present to the user. The locale will be an exact match of one of our officially supported  translations, so clients do not need to implement their own fallback algorithm.",
            "type":"string"
        },
        "logoImage":{
            "description":"Logo image. Can be null.",
            "type":"string"
        },
        "logoText":{
            "description":"Logo text. Can be null.",
            "type":"string"
        },
        "logoutURL":{
            "description":"The URL to redirect to after user logout to complete the logout process,  typically used in SSO integrations. Can be null if this step is not necessary.",
            "type":"string"
        },
        "mailHost":{
            "description":"The mail host that a client can use.",
            "type":"string"
        },
        "maximumChatSize":{
            "description":"Maximum total chat size in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "maximumFileSize":{
            "description":"Maximum per part (file) size in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "maximumRequestsInBatch":{
            "description":"Maximum requests in a batch.",
            "type":"integer",
            "format":"int64"
        },
        "maximumRequestSize":{
            "description":"Maximum total request size in bytes.",
            "type":"integer",
            "format":"int64"
        },
        "numEnteredClients":{
            "description":"If enterHive is enabled during login, the number of clients entered for the session.",
            "type":"integer",
            "format":"int32"
        },
        "platformURL":{
            "description":"Developer site (previously called Platform) URL.",
            "type":"string"
        },
        "presenceIdleMS":{
            "description":"The expected client presence idle timeout in milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "pushEnabled":{
            "description":"Determine which push devices are currently enabled.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XDeviceType"
            }
        },
        "revisionCommitID":{
            "description":"The revision commit ID (hash) or 'no-commitid'.",
            "type":"string"
        },
        "revisionDate":{
            "description":"The revision date in ISO 8601 format or 'no-date'.",
            "type":"string"
        },
        "revisionTag":{
            "description":"The revision tag or 'no-tag'.",
            "type":"string"
        },
        "serverDate":{
            "description":"Server date. Useful to sync dates sent by the server to local time.",
            "type":"string",
            "format":"date"
        },
        "serverDateInISO8601Format":{
            "description":"Server date. Useful to sync dates sent by the server to local time, in ISO 8601 format.",
            "type":"string"
        },
        "serverHosts":{
            "description":"List of all server access hosts.",
            "type":"array",
            "items":{
                "description":"List of all server access hosts.",
                "type":"string"
            }
        },
        "serverMethod":{
            "description":"Server access method.",
            "type":"string"
        },
        "serverPort":{
            "description":"Server access port.",
            "type":"integer",
            "format":"int32"
        },
        "socialChannelHost":{
            "description":"Collaboration channel access host.",
            "type":"string"
        },
        "socialChannelPath":{
            "description":"Collaboration channel access path.",
            "type":"string"
        },
        "socialChannelServletName":{
            "description":"Collaboration channel access servlet name.",
            "type":"string"
        },
        "socialChannelURL":{
            "description":"Collaboration channel access URL.",
            "type":"string"
        },
        "supportDescription":{
            "description":"The support description.",
            "type":"string"
        },
        "themeColor":{
            "description":"The theme color.",
            "type":"string"
        },
        "user":{
            "$ref":"#/definitions/XV1PeopleInfo"
        },
        "version":{
            "description":"The complete release version string.",
            "type":"string"
        }
    }
}

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

型: array

現在どのプッシュ・デバイスが有効になっているかを判定します。

ソースを表示

Array of: object XDeviceType

{
    "description":"Determine which push devices are currently enabled.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XDeviceType"
    }
}

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

型: array

すべてのサーバー・アクセス・ホストのリスト。

ソースを表示

Array of: string

すべてのサーバー・アクセス・ホストのリスト。

{
    "description":"List of all server access hosts.",
    "type":"array",
    "items":{
        "description":"List of all server access hosts.",
        "type":"string"
    }
}

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

型: object

V1人情報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。

{
    "description":"V1 People Information DTO.",
    "properties":{
        "addressBuilding":{
            "description":"This user's building.",
            "type":"string"
        },
        "addressCity":{
            "description":"This user's city.",
            "type":"string"
        },
        "addressCountry":{
            "description":"This user's country.",
            "type":"string"
        },
        "addressLine1":{
            "description":"This user's street address line 1.",
            "type":"string"
        },
        "addressLine2":{
            "description":"This user's street address line 2.",
            "type":"string"
        },
        "addressOffice":{
            "description":"This user's office.",
            "type":"string"
        },
        "addressState":{
            "description":"This user's state.",
            "type":"string"
        },
        "addressZipCode":{
            "description":"This user's ZIP Code.",
            "type":"string"
        },
        "biography":{
            "description":"The biography for this user.",
            "type":"string"
        },
        "chatURL":{
            "description":"A URL specifying this user's one-on-one conversation with the current user.",
            "type":"string",
            "format":"url"
        },
        "company":{
            "description":"This user's company.",
            "type":"string"
        },
        "costCenter":{
            "description":"This user's cost center.",
            "type":"string"
        },
        "dateFormatLocale":{
            "description":"This user's locale for formatting dates.",
            "type":"string",
            "format":"uuid"
        },
        "description":{
            "description":"The user profile description.",
            "type":"string"
        },
        "eMailAddress":{
            "description":"The email address for this user.",
            "type":"string"
        },
        "expertise":{
            "description":"This user's expertise.",
            "type":"string"
        },
        "followersURL":{
            "description":"This user's followers URL. Users that are followers of this user.",
            "type":"string",
            "format":"url"
        },
        "followingURL":{
            "description":"This user's following URL. Users that this user is following.",
            "type":"string",
            "format":"url"
        },
        "fullName":{
            "description":"The full name for this user.",
            "type":"string"
        },
        "interests":{
            "description":"This user's interests.",
            "type":"string"
        },
        "isDeleted":{
            "description":"True if this user is deleted.",
            "type":"boolean"
        },
        "isEnabled":{
            "description":"True if this user is enabled.",
            "type":"boolean"
        },
        "isHidden":{
            "description":"True if the user is to be hidden.",
            "type":"boolean"
        },
        "isIntegrationUser":{
            "description":"True if the user is an integration user.",
            "type":"boolean"
        },
        "isInternal":{
            "description":"True if the user is internal, false if the user is external.",
            "type":"boolean"
        },
        "isOutsider":{
            "description":"True if the user is an outsider.",
            "type":"boolean"
        },
        "languageLocale":{
            "description":"This user's language locale.",
            "type":"string",
            "format":"uuid"
        },
        "lastConnectedDate":{
            "description":"The date this user last connected.",
            "type":"string",
            "format":"date"
        },
        "lastConnectedDateInISO8601Format":{
            "description":"The date this user last connected, in ISO 8601 format.",
            "type":"string"
        },
        "lastDisconnectedDate":{
            "description":"The date this user last disconnected.",
            "type":"string",
            "format":"date"
        },
        "lastDisconnectedDateInISO8601Format":{
            "description":"The date this user last disconnected, in ISO 8601 format.",
            "type":"string"
        },
        "libraryURL":{
            "description":"A URL specifying this user's library.",
            "type":"string",
            "format":"url"
        },
        "link":{
            "description":"A URL, if any, that this user shows on their wall or profile as their link.",
            "type":"string"
        },
        "location":{
            "description":"This user's location.",
            "type":"string"
        },
        "organization":{
            "description":"This user's organization.",
            "type":"string"
        },
        "propertiesURL":{
            "description":"This user's properties URL.",
            "type":"string",
            "format":"url"
        },
        "socialObjectViewID":{
            "description":"The user's current collaboration object view ID (can be null).",
            "type":"string"
        },
        "statisticsURL":{
            "description":"A URL to retrieve this user's statistics.",
            "type":"string",
            "format":"url"
        },
        "timeZone":{
            "description":"This user's time zone.",
            "type":"string",
            "format":"uuid"
        },
        "title":{
            "description":"This user's title.",
            "type":"string"
        },
        "wallURL":{
            "description":"A URL specifying this user's wall.",
            "type":"string",
            "format":"url"
        },
        "originalPictureURL":{
            "description":"The original picture URL.",
            "type":"string",
            "format":"url"
        },
        "profilePictureURL":{
            "description":"The profile picture URL (150 px by 150 px).",
            "type":"string",
            "format":"url"
        },
        "scaledPictureURL":{
            "description":"The scaled picture URL (44 px by 44 px).",
            "type":"string",
            "format":"url"
        },
        "altitude":{
            "description":"The object's altitude.",
            "type":"number",
            "format":"double"
        },
        "collectionURL":{
            "description":"A URL to this object's containing collection.",
            "type":"string",
            "format":"url"
        },
        "conversationURL":{
            "description":"A URL to this object's containing conversation.",
            "type":"string",
            "format":"url"
        },
        "createdByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "createdByURL":{
            "description":"A URL to the user that created this object.",
            "type":"string",
            "format":"url"
        },
        "createdByUserDisplayName":{
            "description":"The display name of the user that created this object.",
            "type":"string"
        },
        "createdByUserName":{
            "description":"The name of the user that created this object.",
            "type":"string"
        },
        "createdDate":{
            "description":"The date this object was created.",
            "type":"string",
            "format":"date"
        },
        "createdDateInISO8601Format":{
            "description":"The date this object was created, in ISO 8601 format.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of this object.",
            "type":"string"
        },
        "id":{
            "$ref":"#/definitions/XObjectID"
        },
        "isRemoved":{
            "description":"True if this message has been removed.",
            "type":"boolean"
        },
        "latitude":{
            "description":"The object's latitude.",
            "type":"number",
            "format":"double"
        },
        "longitude":{
            "description":"The object's longitude.",
            "type":"number",
            "format":"double"
        },
        "modifiedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "modifiedByURL":{
            "description":"A URL to the user that last modified this object.",
            "type":"string",
            "format":"url"
        },
        "modifiedByUserDisplayName":{
            "description":"The display name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedByUserName":{
            "description":"The name of the user that last modified this object.",
            "type":"string"
        },
        "modifiedDate":{
            "description":"The date this object was last modified.",
            "type":"string",
            "format":"date"
        },
        "modifiedDateInISO8601Format":{
            "description":"The date this object was last modified, in ISO 8601 format.",
            "type":"string"
        },
        "name":{
            "description":"The name of this object.",
            "type":"string"
        },
        "objectType":{
            "description":"The type of this object.",
            "type":"string"
        },
        "removedByID":{
            "$ref":"#/definitions/XObjectID"
        },
        "removedByURL":{
            "description":"A URL to the user that last removed this object.",
            "type":"string",
            "format":"url"
        },
        "removedByUserDisplayName":{
            "description":"The display name of the user that last removed this object.",
            "type":"string"
        },
        "removedByUserName":{
            "description":"The name of the user that last removed this object.",
            "type":"string"
        },
        "removedDate":{
            "description":"The date this object was removed.",
            "type":"string",
            "format":"date"
        },
        "removedDateInISO8601Format":{
            "description":"The date this object was removed, in ISO 8601 format.",
            "type":"string"
        },
        "socialObjectURL":{
            "description":"A URL to this object's containing collaboration object.",
            "type":"string",
            "format":"url"
        },
        "url":{
            "description":"A URL to this object.",
            "type":"string",
            "format":"url"
        }
    }
}

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

型: object

ソースを表示

field(optional): string

許容値: [ "APNS", "EMAIL", "GCM", "SMS", "TXT" ]

デバイス・タイプ。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"The device types.",
            "enum":[
                "APNS",
                "EMAIL",
                "GCM",
                "SMS",
                "TXT"
            ]
        }
    }
}

先頭に戻る