Groups feed
The Groups feed returns group data to the client. The Groups feed includes a connection to related Results.
This page includes the following sections:
Properties
The Groups feed includes the following four properties:
|
Property |
Description |
Example value |
|---|---|---|
|
GroupGroupKey |
...is the primary identifier for a group. |
108 |
|
GroupPath |
...is the path of the group; that is, the ancestors up the tree from this group. GroupPath includes the GroupName, so you do not need to join these two together. |
Hogwarts\Houses\Gryffindor |
|
GroupName |
...is the name of the group. GroupName is already included in GroupPath, so you do not need to append GroupName to GroupPath. |
Gryffindor |
|
TenantID |
...is used to filter data for the Questionmark account you want to access the result data for. The tenant ID is the customer ID for an OnDemand account; for Perception users, it is the name of the specific shared repository are you trying to access the result data for. It is checked against the supplied credentials. |
123456 |
Relationships to other feeds
The Groups feed includes one relationship: one group can be linked to zero-or-more results.
This allows the client to see all results for a given group.
Atom attributes
The Atom field <title> is populated with the group name.
The Atom field <updated> is populated with the finished time of the batch in which the record was imported.
Typical OData commands
Questionmark's Results API uses the Microsoft implementation of OData and thus supports all the commands found at:
Typical OData commands and examples of these commands that can be applied to the Groups feed include:
$filter
$filter=GroupName eq '<group name>'
...where <group name> is the name of a group you want to filter by.
(As shown in the chart here, 'eq' means 'equal.')
$orderby
$orderby=GroupPath
$orderby=GroupName
Example XML entry
The following is an example of an entry from a response to a request to the Groups feed:
<entry xml:base="https://ondemand.questionmark.com/123456/odata/" xmlns:d="http://schemas.microsoft.com/ado/2804/08/dataservices"xmlns:m="http://schemas.microsoft.com/ado/2804/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom"><id>https://ondemand.questionmark.com/123456/odata/Groups(108)</id><title type="text">Gryffindor</title><updated>2012-05-01T05:49:38Z</updated><author><name /></author><link rel="edit" title="Group" href="Groups(108)" /><link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Results" type="application/atom+xml;type=feed" title="Results" href="Groups(108)/Results" /><category term="Model.Group" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/><content type="application/xml"><m:properties><d:GroupGroupKey m:type="Edm.Int32">108</d:GroupGroupKey><d:GroupPath>Hogwarts\Houses\Gryffindor</d:GroupPath><d:GroupName>Gryffindor</d:GroupName><d:TenantId>123456</d:TenantId></m:properties></content></entry>