ユーザーとグループのREST API

機械翻訳について

OCEグループを作成します。

post

/social/api/v1/groups

リクエスト

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

application/json

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

ルート・スキーマ : XV1GroupCreateInfo

型: object

V1グループ作成情報。

Show Source

disableNotifications(optional): boolean

グループdisableNotificationsフラグ。オプション。
externalID(optional): string

グループ外部ID。オプション。
groupType(optional): object XV1GroupType
isSystemGroup(optional): boolean

グループがシステム・グループかどうかを示すフラグ。オプション。 NOTE : システム・グループは、OCM内部コンポーネントでのみ管理できます。
name(optional): string

グループ名。必須。

{
    "description":"V1 Group Create Information.",
    "properties":{
        "disableNotifications":{
            "description":"The group disableNotifications flag. Optional.",
            "type":"boolean"
        },
        "isSystemGroup":{
            "description":"Flag indicating if group is a system group. Optional. NOTE : System groups can only be managed by OCM internal components.",
            "type":"boolean"
        },
        "externalID":{
            "description":"The group external ID. Optional.",
            "type":"string"
        },
        "groupType":{
            "$ref":"#/definitions/XV1GroupType"
        },
        "name":{
            "description":"Group name. Required.",
            "type":"string"
        }
    }
}

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

型: object

Show Source

field(optional): string

許容値: [ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]

V1グループ・タイプ。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 group types.",
            "enum":[
                "PRIVATE_CLOSED",
                "PUBLIC_CLOSED",
                "PUBLIC_OPEN"
            ]
        }
    }
}

トップに戻る

レスポンス

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

application/json

200レスポンス

操作の成功

ルート・スキーマ : XV1GroupInfo

型: object

V1グループ情報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。

{
    "description":"V1 Group Information DTO.",
    "properties":{
        "addressBuilding":{
            "description":"The group's address building.",
            "type":"string"
        },
        "addressCity":{
            "description":"The group's address city.",
            "type":"string"
        },
        "addressCountry":{
            "description":"The group's address country.",
            "type":"string"
        },
        "addressLine1":{
            "description":"The group's address line 1.",
            "type":"string"
        },
        "addressLine2":{
            "description":"The group's address line 2.",
            "type":"string"
        },
        "addressOffice":{
            "description":"The group's address office.",
            "type":"string"
        },
        "addressState":{
            "description":"The group's address state.",
            "type":"string"
        },
        "addressZipCode":{
            "description":"The group's address ZIP Code.",
            "type":"string"
        },
        "biography":{
            "description":"The group's biography.",
            "type":"string"
        },
        "company":{
            "description":"The group's company.",
            "type":"string"
        },
        "description":{
            "description":"The group description.",
            "type":"string"
        },
        "eMailAddress":{
            "description":"The group's e-mail address.",
            "type":"string"
        },
        "expertise":{
            "description":"The group's expertise.",
            "type":"string"
        },
        "externalID":{
            "description":"Group's external ID.",
            "type":"string"
        },
        "fullName":{
            "description":"The group's full name.",
            "type":"string"
        },
        "groupID":{
            "description":"Group's ID.",
            "type":"string"
        },
        "groupOriginType":{
            "$ref":"#/definitions/XV1GroupOriginType"
        },
        "groupType":{
            "$ref":"#/definitions/XV1GroupType"
        },
        "groupOwnerID":{
            "description":"Group Owner's ID.",
            "type":"string"
        },
        "interests":{
            "description":"The group's interests.",
            "type":"string"
        },
        "isDeleted":{
            "description":"True if this group is deleted.",
            "type":"boolean"
        },
        "isEditable":{
            "description":"True if this group's realm allows attributes such as name, membership and enabled status  to be edited. The group's manageable status specifies whether the current user can edit any of  these fields.",
            "type":"boolean"
        },
        "isInternal":{
            "description":"True if the group is internal, False if the group is external.",
            "type":"boolean"
        },
        "isManageable":{
            "description":"True if the current user has permissions to edit (manage) this group.",
            "type":"boolean"
        },
        "isNotificationDisabled":{
            "description":"Group's Notification flag.",
            "type":"boolean"
        },
        "isSharingDisabled":{
            "description":"Group's Sharing flag.",
            "type":"boolean"
        },
        "isSystemGroup":{
            "description":"Flag indicating if group is a system group.",
            "type":"boolean"
        },
        "libraryURL":{
            "description":"A URL specifying this group's library.",
            "type":"string",
            "format":"url"
        },
        "link":{
            "description":"A URL if any that the group shows on their wall or profile as their link.",
            "type":"string"
        },
        "membershipURL":{
            "description":"A URL to the membership of this group.",
            "type":"string",
            "format":"url"
        },
        "membersURL":{
            "description":"A URL to the members of this group.",
            "type":"string",
            "format":"url"
        },
        "organization":{
            "description":"The group's organization.",
            "type":"string"
        },
        "wallURL":{
            "description":"A URL specifying this group'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"
        }
    }
}

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

型: object

Show Source

field(optional): string

許容値: [ "CEC", "IDP" ]

グループの作成元の元を表示する列挙型。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"Enum to list the source of origin from where the Groups are originally created.",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    }
}

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

型: object

Show Source

field(optional): string

許容値: [ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]

V1グループ・タイプ。

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 group types.",
            "enum":[
                "PRIVATE_CLOSED",
                "PUBLIC_CLOSED",
                "PUBLIC_OPEN"
            ]
        }
    }
}

トップに戻る