指定したグループを更新
patch
/social/api/v1/groups/{groupID}
IDCSグループの場合、変更できるのはDisableNotificationsおよびDisableSharing属性のみです。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- groupID: integer(int64)
グループID。 オブジェクトのlong integer表現の一意識別子。
リクエスト本文は、リクエストの詳細を定義します。
ルート・スキーマ : XV1GroupUpdateInfo
型:
objectV1グループの更新情報。
Show Source
- profileUpdater(optional): object XGroupProfileUpdater
グループ・プロファイルのアップ・データ。
- updater(optional): object XGroupUpdater
グループのアップ・データ。
ネストされたスキーマ : XGroupProfileUpdater
型:
objectグループ・プロファイルのアップ・データ。
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): string
オプション。 高度のdouble値。
- Biography(optional): string
オプション。 グループ伝記の文字列。
- Company(optional): string
オプション。 グループ会社の文字列。
- CustomFields(optional): string
オプション。 すべてのカスタム・フィールドのコレクション。
- Description(optional): string
オプション。 グループ記述の文字列。
- EMailAddress(optional): string
オプション。 グループのメール・アドレス。
- Expertise(optional): string
オプション。 グループの専門知識のための文字列。
- fMap(optional): string
含まれるマップ(文字列から値)。
- FullName(optional): string
オプション。 グループのフルネーム(たとえば、'John Reports')。 これを使用してDisplayName値を生成できます。
- Interests(optional): string
オプション。 グループの興味のための文字列。
- Latitude(optional): string
オプション。 緯度のdouble値。
- Link(optional): string
オプション。 名前(文字列)をリンク(文字列)とするすべてのリンクのマップ。
- Links(optional): string
オプション。 XGroupLinkInfoのコレクション。
- Location(optional): string
オプション。 グループのロケーションの文字列。
- Locations(optional): string
オプション。 XGroupLocationInfoのコレクション。
- Longitude(optional): string
オプション。 経度のdouble値。
- Manager(optional): string
オプション。 グループ・マネージャ。
- Organization(optional): string
オプション。 グループ構成の文字列。
- PhoneNumber(optional): string
オプション。 このグループの電話番号。 これまたはPHONE_NUMBERSを使用し、両方は使用しないでください。 すべての電話番号を置換します。 このフィールドによって、すべての電話番号が1つの番号に設定されます。 これよりPHONE_NUMBERSが優先されます。
- PhoneNumbers(optional): string
オプション。 名前(文字列)から番号(文字列)へのすべての電話番号のマップ。 これまたはPHONE_NUMBERを使用し、両方は使用しないでください。 すべての電話番号を置換します。 すべての電話番号を変更するために使用する正しいフィールドです。
- Status(optional): string
オプション。 グループ・ステータスの文字列。
- Tags(optional): string
オプション。 追加する(文字列)タグを含むコレクション。
ネストされたスキーマ : XGroupUpdater
型:
objectグループのアップ・データ。
Show Source
- Deleted(optional): string
オプション。 削除されたステータスの文字列。
- DisableNotifications(optional): string
オプション。 disableNotificationsフラグの文字列。 ノート : この属性は、グループ所有者/マネージャおよび管理者によって変更できます。
- DisableSharing(optional): string
オプション。 disableSharingフラグの文字列。 NOTE : この属性は管理者のみが変更できます。
- ExternalID(optional): string
オプション。 グループ外部IDの文字列。
- fMap(optional): string
含まれるマップ(文字列から値)。
- GroupType(optional): string
オプション。 グループ・タイプの文字列。
- IsSystemGroup(optional): string
オプション。 システム・グループ・フラグの文字列。 ノート : システム・グループは、OCM内部コンポーネントでのみ管理できます。
- Name(optional): string
オプション。 名前の文字列。
- Owner(optional): string
オプション。 グループ所有者名の文字列。 新規所有者はグループの既存のメンバーである必要があります。 古い所有者ステータスが無効/削除済の場合、所有者はグループ・メンバーシップから削除され、ステータスがアクティブの場合、その所有者はグループのマネージャのままになります。 NOTE : この属性は管理者のみが変更できます。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ : XV1GroupInfo
型:
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
グループの伝記。
- collectionURL(optional): string(url)
コレクションを含むこのオブジェクトのURLです。
- company(optional): string
グループ会社。
- conversationURL(optional): string(url)
このオブジェクトに含まれる会話へのURL。
- createdByID(optional):
オブジェクトのlong integer表現の一意識別子。
- createdByURL(optional): string(url)
このオブジェクトを作成したユーザーへのURL。
- createdByUserDisplayName(optional): string
このオブジェクトを作成したユーザーの表示名。
- createdByUserName(optional): string
このオブジェクトを作成したユーザーの名前。
- createdDate(optional): string(date)
このオブジェクトが作成された日付。
- createdDateInISO8601Format(optional): string
このオブジェクトが作成された日付(ISO 8601書式)。
- description(optional): string
グループの説明。
- displayName(optional): string
このオブジェクトの表示名。
- eMailAddress(optional): string
グループ電子メール・アドレス。
- expertise(optional): string
グループの専門知識。
- externalID(optional): string
グループ外部ID。
- fullName(optional): string
グループのフルネーム。
- groupID(optional): string
グループID。
- groupOriginType(optional): object XV1GroupOriginType
- groupOwnerID(optional): string
グループ所有者ID。
- groupType(optional): object XV1GroupType
- id(optional):
オブジェクトのlong integer表現の一意識別子。
- interests(optional): string
グループの利益。
- isDeleted(optional): boolean
このグループが削除されている場合はtrue。
- isEditable(optional): boolean
このグループ・レルムが、名前、メンバーシップ、有効なステータスなどの属性を編集できる場合はtrueです。 グループ管理可能ステータスは、現在のユーザーがこれらのフィールドのいずれかを編集できるかどうかを指定します。
- isInternal(optional): boolean
グループが内部の場合はTrue、グループが外部の場合はFalse。
- isManageable(optional): boolean
現在のユーザーにこのグループを編集(管理)する権限がある場合はtrueです。
- isNotificationDisabled(optional): boolean
グループ通知フラグ。
- isRemoved(optional): boolean
このメッセージが削除された場合はTrue。
- isSharingDisabled(optional): boolean
グループ共有フラグ。
- isSystemGroup(optional): boolean
グループがシステム・グループかどうかを示すフラグ。
- latitude(optional): number(double)
オブジェクトの緯度。
- libraryURL(optional): string(url)
このグループ・ライブラリを指定するURL。
- link(optional): string
グループがリンクとしてウォールまたはプロファイルに表示される場合、URL。
- longitude(optional): number(double)
オブジェクトの経度。
- membershipURL(optional): string(url)
このグループのメンバーシップのURL。
- membersURL(optional): string(url)
このグループのメンバーへのURL。
- 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ピクセル)。
- 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。
- url(optional): string(url)
このオブジェクトへのURL。
- wallURL(optional): string(url)
このグループ・ウォールを指定するURL。
ネストされたスキーマ : XV1GroupOriginType
型:
Show Source
object- field(optional): string
許容値:
[ "CEC", "IDP" ]グループの作成元の元を表示する列挙型。
ネストされたスキーマ : XV1GroupType
型:
Show Source
object- field(optional): string
許容値:
[ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]V1グループ・タイプ。