Get all user groups assigned to content
/km/api/v1/content/{id}/userGroups
This method returns a list of UserGroup objects associated with the Content object having the specified ID parameter.
This resource supports the orderBy request parameter. You can use this parameter along with the HTTP service request to sort the returned list.
You must get the schema and catalog of the resource for additional values that you can use with the orderBy parameter.
To get the schema and catalog of the resource, you must use the GET method with the mediaType value as 'application/schema+json'
in the HTTP request.
The example URI to get schema and catalog of the resource is as follows:
http://<IM_REST_API_HOST>/km/api/latest /metadata-catalog/userGroups
Example URIs
Following are the example URIs for this method:
http://<IM_REST_API_HOST>/km/api/latest /content/{id}/userGroups?orderBy=referenceKey:asec
The request returns a list of UserGroup objects associated with the Content object having the specified ID parameter sorted by reference key in ascending order.
http://<IM_REST_API_HOST>/km/api/latest /content/{id}/userGroups?orderBy=referenceKey:desc
The request returns a list of UserGroup objects associated with the Content object having the specified ID parameter sorted by reference key in descending order.
Request
-
id: string
The unique identifier of the Content object
Response
- application/json
- application/xml
200 Response
object
ResultList UserGroupKey
-
count(optional):
integer
Number of resource instances returned in the current range.
-
hasMore(optional):
boolean
Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
-
items(optional):
array items
-
limit(optional):
integer
Actual paging size used by the server.
-
links(optional):
array links
-
offset(optional):
integer
Offset value used in the current page.
-
totalResults(optional):
integer
Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
UserGroupKey
-
externalId(optional):
integer
The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.
-
externalType(optional):
string
The ExternalType is the type of the corresponding userGroup from an external system.
-
links(optional):
array links
-
name(optional):
string
The localized name of the user group. The name field can only be used for sorting.
-
recordId(optional):
string
The unique identifier from the TAG table that represent a userGroups resource
-
referenceKey(optional):
string
The non localized name of the user group
-
stripeCD(optional):
string
Stripe for UserGroup
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object
-
href:
string
URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
-
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
-
profile(optional):
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel:
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
-
templated(optional):
boolean
Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
Examples
The following example shows how to find all the User Group objects associated with the Content object that has the specified ID.
curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/content/{id}/userGroups" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "recordId": "-5", "referenceKey": "NULLTAG", "name": "NULLTAG", "links": [ { "rel": "canonical", "href": "https://IM_REST_API_HOST/km/api/latest/userGroups/-5", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://IM_REST_API_HOST/km/api/latest/userGroups", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://IM_REST_API_HOST/km/api/latest/metadata-catalog/userGroups" } ] } ], "hasMore": false, "limit": 20, "offset": 0, "links": [ { "rel": "canonical", "href": "https://IM_REST_API_HOST/km/api/latest/content/0400362a57eb0e0157d88fc1db007f49/userGroups?limit=20&offset=0", "mediaType": "application/json, application/xml", "method": "GET" } ], "count": 1 }