Find all
/km/api/v1/userGroups
This method returns a list of UserGroup objects that match the specified criteria.
This resource supports the orderBy request parameter, which allows you to sort the returned list of UserGroup objects.
You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use 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
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/latest/userGroups
The request returns a paginated list of the UserGroup objects in DATA mode. Objects in the list are sorted according to the record ID in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/userGroups?mode=KEY
The request returns a paginated list of UserGroup objects in KEY mode. Objects in the list are sorted according to the record ID in ascending order.
http://<IM_REST_API_HOST>/km/api/latest/userGroups?orderBy=name
The request returns a paginated list of UserGroup objects in DATA mode. Objects in the list are sorted according to the name in ascending order.
Find by query
Supported Media Types: 'application/json', 'application/xml'
This method returns a list of UserGroup objects that match the specified criteria.
This resource supports the orderBy request parameter, which allows you to sort the returned list of UserGroup objects.
You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use 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
The example URIs for this method are as follows:
http://<IM_REST_API_HOST>/km/api/userGroups?q=dateAdded after '2015-01-01'&orderBy=dateAdded
The request returns a paginated list of User Group objects in DATA mode that were added after January 1, 2015. Objects in the list are sorted by the most recent date added.
http://<IM_REST_API_HOST>/km/api/latest/languages?q=languageCode eq 'en'
The request returns a paginated list of Language objects associated with the English language. By default, the Language objects are sorted by the date when the object was created, in ascending order.
http://<IM_REST_API_HOST>/km/api/userGroups?q=referenceKey in ('USERGROUP1', 'USERGROUP2', 'USERGROUP3')
The request returns a paginated list of User Group objects in DATA mode that have any of the following referenceKey values: USERGROUP1, USERGROUP2, USERGROUP3. Objects in the list are sorted by date when the object was created in descending order.
The following table describes the query parameters for this resource.
Parameter | Queryable | Sortable | Type | Description |
---|---|---|---|---|
recordId | Y | Y | 'type' : 'string' | The unique identifier from the TAG table that represent a userGroups resource |
referenceKey | Y | Y | 'type' : 'string' | The non localized name of the user group |
name | N | Y | 'type' : 'string' | The localized name of the user group. The name field can only be used for sorting. |
externalId | Y | Y | 'type' : '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 | Y | Y | 'type' : 'string' | The ExternalType is the type of the corresponding userGroup from an external system. |
dateAdded | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the UserGroup object was created |
dateModified | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the UserGroup object was last modified |
Request
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
mode:
This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.Allowed Values:
[ "KEY", "DATA", "EXTENDED", "FULL" ]
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
-
q: string
Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Response
- application/json
- application/xml
200 Response
object
ResultList UserGroupData
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList UserGroupData-allOf[1]
Collection Paging Resource
-
allOf
Base Collection Resource
Title:
Base Collection Resource
Oracle base collection resource schema definition. -
object
Collection Paging Resource-allOf[1]
Base Collection Resource
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
Base Collection Resource-allOf[1]
object
Singular Resource
object
-
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.
-
limit(optional):
integer
Actual paging size used by the server.
-
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
-
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.
object
-
object
Singular Resource
Title:
Singular Resource
Oracle base singular resource schema definition. -
object
UserGroupKey-allOf[1]
object
-
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.
-
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
object
-
dateAdded(optional):
string(date-time)
The date when the UserGroup object was created
-
dateModified(optional):
string(date-time)
The date when the UserGroup object was last modified
-
description(optional):
string
The localized description of the user group
-
objectId(optional):
string
The string representing the hierarchy of the user groups. All user groups are stored in the TAG table but they are currently not hierarchical
Examples
The following example shows how to find all User Group objects from Oracle Knowledge repository by submitting a get request on the REST resource using cURL.
cURL Command
Command: curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/userGroups"
Example of Request Header
The following shows an example of the request header.
-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \ -H "Accept: application/json"
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "dateAdded" : "2013-04-23T23:29:07EDT", "dateModified" : "2013-04-23T23:29:07EDT", "description" : "DESCRIPTION_VALUE", "referenceKey" : "REFERENCEKEY_VALUE", "name" : "NAME_VALUE", "externalId" : 1428417268265, "externalType" : "EXTERNALTYPE_VALUE", "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}", "mediaType" : "application/json, application/xml", "templated" : true, "method" : "GET", "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}" } ] } } ], "hasMore" : false, "limit" : 20, "offset" : 0, "links" : [ { "rel" : "canonical", "href" : "http://<IM_REST_API_HOST>/km/api/{version}/userGroups?limit=20&offset=0", "mediaType" : "application/json, application/xml", "method" : "GET" } ], "count" : 1 }