1. REST API for Knowledge Advanced in B2C Service
  2. Tasks
  3. Content (IM)
  4. Data Forms

Find all

get

/km/api/v1/dataForms

This method returns a list of DataForm 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/dataForms

Find by query

Supported Media Types: 'application/json', 'application/xml'


This method returns a list of DataForm 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/dataForms
Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'Documentation for field recordId
referenceKeyYY'type' : 'string'Documentation for field referenceKey
dateAddedYY'type' : 'string', 'format' : 'date-time'Documentation for field dateAdded
dateModifiedYY'type' : 'string', 'format' : 'date-time'Documentation for field dateModified
emailContentYY'type' : 'boolean'Documentation for field emailContent
nameNY'type' : 'string'The name of the data form. The name field can only be used for sorting.
displayEndDateYY'type' : 'string', 'format' : 'date-time'Documentation for field displayEndDate
displayStartDateYY'type' : 'string', 'format' : 'date-time'Documentation for field displayStartDate
ratingTypeYY'type' : 'integer'Determined whether it is a 5 star or Y/N type of rating
  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)
questionsYN'$ref' : '#/definitions/ListDataFormQuestion'To Many Relationship to Question
userYN'$ref' : '#/definitions/UserKey'Relationship to User
viewsYN'$ref' : '#/definitions/ListViewKey'To Many Relationship to View

Request

Query Parameters
  • 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.
  • 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" ]
  • 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.
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList DataFormData
Type: object
Title: ResultList DataFormData
Match All
Show Source
Nested Schema : Collection Paging Resource
Title: Collection Paging Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Base Collection Resource
Title: Base Collection Resource
Oracle base collection resource schema definition.
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : Base Collection Resource-allOf[1]
Type: object
Show Source
Nested Schema : Collection Paging Resource-allOf[1]
Type: object
Show Source
Nested Schema : ResultList DataFormData-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
Type: object
Nested Schema : items
Type: array
Show Source
Nested Schema : DataFormData
Match All
Show Source
Nested Schema : DataFormKey
Match All
Show Source
Nested Schema : DataFormKey-allOf[1]
Type: object
Show Source
Nested Schema : DataFormData-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find all Data Form 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/dataForms"

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-30T21:34:19EDT",
    "dateModified" : "2013-04-30T21:34:19EDT",
    "emailContent" : true,
    "name" : "NAME_VALUE",
    "ratingType" : -579711169,
    "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}/dataForms?limit=20&offset=0",
    "mediaType" : "application/json, application/xml",
    "method" : "GET"
  } ],
  "count" : 1
}
Back to Top