GET v1/Groups/Details/

Retrieves the ID, Name, and Entity Type for each Entity in the requested group.

Request Information

Parameters

Name	Type	Description	Additional information
request	GroupGetDetailsRequest	Container for the Group Details Request input parameters. See parameter details below.	Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property	Type	Description
Id	String	The ID of the Group.
SdkVersion	String	If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "entities": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "entityType": "Public"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "entityType": "Public"
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "entityType": "Public"
    }
  ],
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "id": "sample string 1",
    "sdkVersion": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<GroupGetDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 2</SdkVersion>
    <Id>sample string 1</Id>
  </Request>
  <Entities>
    <GroupEntity>
      <EntityType>Public</EntityType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </GroupEntity>
    <GroupEntity>
      <EntityType>Public</EntityType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </GroupEntity>
    <GroupEntity>
      <EntityType>Public</EntityType>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
    </GroupEntity>
  </Entities>
</GroupGetDetailsResponse>