Find all
/km/api/v1/dataLists
This method returns a list of DataList objects from the Oracle Knowledge Repository.
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/dataLists
Find by query
Supported Media Types: 'application/json', 'application/xml'
This method returns a list of DataList objects that match the specified criteria.
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/dataLists
Example URIs
Following are the example URIs for this method:
http://<IM_REST_API_HOST>/km/api/latest/dataLists?q=sortValueSource eq '//FAQ/SUMMARY'
The request returns a list of DataList objects that use strings within the SUMMARY attribute of the FAQ Content Channel for sorting.
http://<IM_REST_API_HOST>/km/api/latest/dataLists?q=dateAdded gt '2015-02-01'
The request returns a list of DataList objects added since February 1st, 2015.
The following table describes the query parameters for this resource.
Parameter | Queryable | Sortable | Type | Description |
---|---|---|---|---|
recordId | Y | Y | 'type' : 'string' | The unique identifier of the DataList object. |
referenceKey | Y | Y | 'type' : 'string' | The reference key for the DataList object. |
dateAdded | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the data list was created. |
dateModified | Y | Y | 'type' : 'string', 'format' : 'date-time' | The date when the data list was last modified. |
defaultValue | Y | Y | 'type' : 'string' | The value compared to defaultValueSource using defaultValueOperator to determine the default data list item. |
defaultValueOperator | Y | Y | 'type' : 'integer' | Operator used when comparing defaultValue to defaultValueSource to determine the default data list item. 1 represents equals, 2 represents not equals. |
defaultValueSource | Y | Y | 'type' : 'string' | The source compared to defaultValue using defaultValueOperator. The source is an attribute of a content channel. |
displaySource | Y | Y | 'type' : 'string' | Source of strings displayed for data list items. This source is an attribute of a content channel. |
name | N | Y | 'type' : 'string' | The name of the data list. The name field can only be used for sorting. |
sortValueSource | Y | Y | 'type' : 'string' | The source of strings used for sorting data list items. This source is an attribute of a content channel. |
staticSort | Y | Y | 'type' : 'boolean' | Sorting type for static data lists. Either 'S' for the sort order defined in the list, or 'A' for alphabetical. |
useContentGuid | Y | Y | 'type' : 'boolean' | Unused. |
useOrFilter | Y | Y | 'type' : 'string' | Unused. |
valueSource | Y | Y | 'type' : 'string' | The source of strings used as values for data list items. This source is an attribute of a content channel. |
contentType | Y | N | '$ref' : '#/definitions/ContentTypeKey' | Relationship to ContentChannel |
dataListFilters | Y | N | '$ref' : '#/definitions/ListDataListFilterKey' | To Many Relationship to DataListFilter |
dataListItems | Y | N | '$ref' : '#/definitions/ListDataListItemKey' | To Many Relationship to DataListItem |
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 DataListData
-
allOf
Collection Paging Resource
Title:
Collection Paging Resource
Oracle base collection resource schema definition. -
object
ResultList DataListData-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
DataListKey-allOf[1]
object
-
recordId(optional):
string
The unique identifier of the DataList object.
-
referenceKey(optional):
string
The reference key for the DataList object.
object
-
dateAdded(optional):
string(date-time)
The date when the data list was created.
-
dateModified(optional):
string(date-time)
The date when the data list was last modified.
-
defaultValue(optional):
string
The value compared to defaultValueSource using defaultValueOperator to determine the default data list item.
-
defaultValueOperator(optional):
integer
Operator used when comparing defaultValue to defaultValueSource to determine the default data list item. 1 represents equals, 2 represents not equals.
-
defaultValueSource(optional):
string
The source compared to defaultValue using defaultValueOperator. The source is an attribute of a content channel.
-
displaySource(optional):
string
Source of strings displayed for data list items. This source is an attribute of a content channel.
-
name(optional):
string
The name of the data list. The name field can only be used for sorting.
-
sortValueSource(optional):
string
The source of strings used for sorting data list items. This source is an attribute of a content channel.
-
staticSort(optional):
boolean
Sorting type for static data lists. Either 'S' for the sort order defined in the list, or 'A' for alphabetical.
-
useContentGuid(optional):
boolean
Unused.
-
useOrFilter(optional):
string
Unused.
-
valueSource(optional):
string
The source of strings used as values for data list items. This source is an attribute of a content channel.
Examples
The following example shows how to find all Data List 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/dataLists"
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:10EDT", "dateModified" : "2013-04-23T23:29:10EDT", "defaultValue" : "DEFAULTVALUE_VALUE", "defaultValueOperator" : -860759087, "defaultValueSource" : "DEFAULTVALUESOURCE_VALUE", "displaySource" : "DISPLAYSOURCE_VALUE", "name" : "NAME_VALUE", "sortValueSource" : "SORTVALUESOURCE_VALUE", "staticSort" : true, "useContentGuid" : true, "useOrFilter" : "USEORFILTER_VALUE", "valueSource" : "VALUESOURCE_VALUE", "referenceKey" : "REFERENCEKEY_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}/dataLists?limit=20&offset=0", "mediaType" : "application/json, application/xml", "method" : "GET" } ], "count" : 1 }