Jump to

• Request
• Response

Get a list of all enabled groups.

get

/social/api/v1/groups

Request

Supported Media Types

• application/json

Body ()

Specify a filter to query.

Root Schema : XV1GroupFilterInfo

Type: object

V1 Group Filter Information.

Show Source

• groupTypes(optional): array groupTypes
  Filter by group types.
• limitToMemberGroups(optional): boolean
  The limit to group member only flag if its True then only Groups in which User is a member will be returned External groups will not be included. If Its false All valid groups will be returned . Optional.
• matchAllRoles(optional): boolean
  The matchAllRoles flag if its True then only Groups in which all Roles given in request are present will be returned. If Its false then all groups with any role given in request will be returned . Optional.
• roles(optional): array roles
  Filter by CEC roles,if role is passed then only groups having these roles will be returned. optional .

{
    "description":"V1 Group Filter Information.",
    "properties":{
        "groupTypes":{
            "description":"Filter by group types.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1GroupType"
            }
        },
        "roles":{
            "description":"Filter by CEC roles,if role is passed then only groups having these roles will be returned. optional .",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XCECApplicationRoles"
            }
        },
        "limitToMemberGroups":{
            "description":"The limit to group member only flag if its True then only Groups in which User is a member will be returned  External groups will not be included. If Its false All valid groups will be returned . Optional.",
            "type":"boolean"
        },
        "matchAllRoles":{
            "description":"The matchAllRoles flag if its True then only Groups in which all Roles given in request are present will be returned. If Its false then all groups with any role given in request will be returned . Optional.",
            "type":"boolean"
        }
    }
}

Nested Schema : groupTypes

Type: array

Filter by group types.

Show Source

• Array of: object XV1GroupType

{
    "description":"Filter by group types.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1GroupType"
    }
}

Nested Schema : roles

Type: array

Filter by CEC roles,if role is passed then only groups having these roles will be returned. optional .

Show Source

• Array of: object XCECApplicationRoles

{
    "description":"Filter by CEC roles,if role is passed then only groups having these roles will be returned. optional .",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XCECApplicationRoles"
    }
}

Nested Schema : XV1GroupType

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]

  V1 group types.

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

Nested Schema : XCECApplicationRoles

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "CECCONTENTADMINISTRATOR", "CECDEVELOPERUSER", "CECENTERPRISEUSER", "CECEXTERNALUSER", "CECINTEGRATIONUSER", "CECREPOSITORYADMINISTRATOR", "CECSERVICEADMINISTRATOR", "CECSITESADMINISTRATOR", "CECSITESVISITOR", "CECSTANDARDUSER", "CECCAPTUREADMINISTRATOR", "CECCAPTURECLIENT", "CECEXPERIENCEADMINISTRATOR", "CECENTERPRISEEXTERNALUSER", "CECDISCOVERYUSER" ]

  CEC Application roles.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"CEC Application roles.",
            "enum":[
                "CECCONTENTADMINISTRATOR",
                "CECDEVELOPERUSER",
                "CECENTERPRISEUSER",
                "CECEXTERNALUSER",
                "CECINTEGRATIONUSER",
                "CECREPOSITORYADMINISTRATOR",
                "CECSERVICEADMINISTRATOR",
                "CECSITESADMINISTRATOR",
                "CECSITESVISITOR",
                "CECSTANDARDUSER",
                "CECCAPTUREADMINISTRATOR",
                "CECCAPTURECLIENT",
                "CECEXPERIENCEADMINISTRATOR",
                "CECENTERPRISEEXTERNALUSER",
                "CECDISCOVERYUSER"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1GroupListInfo

Type: object

V1 Group List Information DTO.

Show Source

• hasMore(optional): boolean
  If true, there are more items to be returned.
• items(optional): array items
  The groups being returned.
• nextURL(optional): string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL(optional): string(url)
  Previous page URL for the list. Null if this is the first page.
• total(optional): integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"V1 Group List Information DTO.",
    "properties":{
        "items":{
            "description":"The groups being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1GroupInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The groups being returned.

Show Source

• Array of: object XV1GroupInfo
  V1 Group Information DTO.

{
    "description":"The groups being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1GroupInfo"
    }
}

Nested Schema : XV1GroupInfo

Type: object

V1 Group Information DTO.

Show Source

• addressBuilding(optional): string
  The group's address building.
• addressCity(optional): string
  The group's address city.
• addressCountry(optional): string
  The group's address country.
• addressLine1(optional): string
  The group's address line 1.
• addressLine2(optional): string
  The group's address line 2.
• addressOffice(optional): string
  The group's address office.
• addressState(optional): string
  The group's address state.
• addressZipCode(optional): string
  The group's address ZIP Code.
• altitude(optional): number(double)
  The object's altitude.
• biography(optional): string
  The group's biography.
• collectionURL(optional): string(url)
  A URL to this object's containing collection.
• company(optional): string
  The group's company.
• conversationURL(optional): string(url)
  A URL to this object's containing conversation.
• createdByID(optional):
  An object's unique identifier from a long integer representation.
• createdByURL(optional): string(url)
  A URL to the user that created this object.
• createdByUserDisplayName(optional): string
  The display name of the user that created this object.
• createdByUserName(optional): string
  The name of the user that created this object.
• createdDate(optional): string(date)
  The date this object was created.
• createdDateInISO8601Format(optional): string
  The date this object was created, in ISO 8601 format.
• description(optional): string
  The group description.
• displayName(optional): string
  The display name of this object.
• eMailAddress(optional): string
  The group's e-mail address.
• expertise(optional): string
  The group's expertise.
• externalID(optional): string
  Group's external ID.
• fullName(optional): string
  The group's full name.
• groupID(optional): string
  Group's ID.
• groupOriginType(optional): object XV1GroupOriginType
• groupOwnerID(optional): string
  Group Owner's ID.
• groupType(optional): object XV1GroupType
• id(optional):
  An object's unique identifier from a long integer representation.
• interests(optional): string
  The group's interests.
• isDeleted(optional): boolean
  True if this group is deleted.
• isEditable(optional): boolean
  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.
• isInternal(optional): boolean
  True if the group is internal, False if the group is external.
• isManageable(optional): boolean
  True if the current user has permissions to edit (manage) this group.
• isNotificationDisabled(optional): boolean
  Group's Notification flag.
• isRemoved(optional): boolean
  True if this message has been removed.
• isSharingDisabled(optional): boolean
  Group's Sharing flag.
• isSystemGroup(optional): boolean
  Flag indicating if group is a system group.
• latitude(optional): number(double)
  The object's latitude.
• libraryURL(optional): string(url)
  A URL specifying this group's library.
• link(optional): string
  A URL if any that the group shows on their wall or profile as their link.
• longitude(optional): number(double)
  The object's longitude.
• membershipURL(optional): string(url)
  A URL to the membership of this group.
• membersURL(optional): string(url)
  A URL to the members of this group.
• modifiedByID(optional):
  An object's unique identifier from a long integer representation.
• modifiedByURL(optional): string(url)
  A URL to the user that last modified this object.
• modifiedByUserDisplayName(optional): string
  The display name of the user that last modified this object.
• modifiedByUserName(optional): string
  The name of the user that last modified this object.
• modifiedDate(optional): string(date)
  The date this object was last modified.
• modifiedDateInISO8601Format(optional): string
  The date this object was last modified, in ISO 8601 format.
• name(optional): string
  The name of this object.
• objectType(optional): string
  The type of this object.
• organization(optional): string
  The group's organization.
• originalPictureURL(optional): string(url)
  The original picture URL.
• profilePictureURL(optional): string(url)
  The profile picture URL (150 px by 150 px).
• removedByID(optional):
  An object's unique identifier from a long integer representation.
• removedByURL(optional): string(url)
  A URL to the user that last removed this object.
• removedByUserDisplayName(optional): string
  The display name of the user that last removed this object.
• removedByUserName(optional): string
  The name of the user that last removed this object.
• removedDate(optional): string(date)
  The date this object was removed.
• removedDateInISO8601Format(optional): string
  The date this object was removed, in ISO 8601 format.
• scaledPictureURL(optional): string(url)
  The scaled picture URL (44 px by 44 px).
• socialObjectURL(optional): string(url)
  A URL to this object's containing collaboration object.
• url(optional): string(url)
  A URL to this object.
• wallURL(optional): string(url)
  A URL specifying this group's wall.

{
    "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"
        }
    }
}

Nested Schema : XV1GroupOriginType

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "CEC", "IDP" ]

  Enum to list the source of origin from where the Groups are originally created.

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

Nested Schema : XV1GroupType

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "PRIVATE_CLOSED", "PUBLIC_CLOSED", "PUBLIC_OPEN" ]

  V1 group types.

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

Back to Top