Find by ID

get

/km/api/v1/dataForms/{id}

This method returns the DataForm object having the specified ID parameter.

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/dataForms/{id}

    The request returns the DataForm object having specified ID parameter in FULL mode.

  • http://<IM_REST_API_HOST>/km/api/dataForms/{id}?mode=KEY

    The request returns the DataForm object having specified ID parameter in the KEY mode.

Response Errors

  • OKDOM-GEN0001

    The error occurs when an invalid id has been given.

Request

Path Parameters
  • The unique identifier of the object to be retrieved.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : DataForm
Match All
Show Source
Nested Schema : DataFormData
Match All
Show Source
Nested Schema : DataFormKey
Match All
Show Source
Nested Schema : Singular Resource
Type: object
Title: Singular Resource
Oracle base singular resource schema definition.
Show Source
Nested Schema : DataFormKey-allOf[1]
Type: object
Show Source
Nested Schema : DataFormData-allOf[1]
Type: object
Show Source
Nested Schema : DataForm-allOf[1]
Type: object
Show Source
Nested Schema : questions
Type: array
To Many Relationship to Question
Show Source
Nested Schema : UserKey
Match All
Show Source
Nested Schema : views
Type: array
To Many Relationship to View
Show Source
Nested Schema : DataFormQuestion
Match All
Show Source
Nested Schema : DataFormQuestionData
Match All
Show Source
Nested Schema : DataFormQuestionKey
Match All
Show Source
Nested Schema : DataFormQuestionKey-allOf[1]
Type: object
Show Source
  • The unique record ID of the DataFormQuestion object.
  • The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.
Nested Schema : DataFormQuestionData-allOf[1]
Type: object
Show Source
Nested Schema : DataFormQuestion-allOf[1]
Type: object
Show Source
Nested Schema : answers
Type: array
To Many Relationship to Answer
Show Source
Nested Schema : DataFormAnswer
Match All
Show Source
Nested Schema : DataFormAnswerData
Match All
Show Source
Nested Schema : DataFormAnswerKey
Match All
Show Source
Nested Schema : DataFormAnswerKey-allOf[1]
Type: object
Show Source
Nested Schema : DataFormAnswerData-allOf[1]
Type: object
Show Source
Nested Schema : DataFormAnswer-allOf[1]
Type: object
Show Source
Nested Schema : UserKey-allOf[1]
Type: object
Show Source
Nested Schema : ViewKey
Match All
Show Source
Nested Schema : ViewKey-allOf[1]
Type: object
Show Source
Back to Top

Examples

The following example shows how to find the Data Form object that has the specified ID parameter by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/dataForms/{id}"

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.

{
  "questions" : [ {
    "answers" : [ {
      "dataFormQuestion" : {
        "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"
        } ]
      },
      "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"
      } ],
      "dateAdded" : "2013-04-30T21:34:16EDT",
      "dateModified" : "2013-04-30T21:34:16EDT",
      "defaultAnswer" : true,
      "numberValue" : -1671597332,
      "sortOrder" : -353731499,
      "name" : "NAME_VALUE"
    } ],
    "dataForm" : {
      "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}"
      } ]
    },
    "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"
    } ],
    "dateAdded" : "113155922-04-08T16:16:58EDT",
    "isMasterIdentifier" : true,
    "required" : true,
    "sortOrder" : -531840921,
    "specialTypeIndicator" : -1235851739,
    "name" : "NAME_VALUE"
  } ],
  "user" : {
    "name" : "NAME_VALUE",
    "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}"
    } ]
  },
  "views" : [ {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_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}"
    } ]
  } ],
  "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}"
  } ],
  "dateAdded" : "61169040-05-21T06:32:41EDT",
  "dateModified" : "193992048-01-24T22:52:53EST",
  "emailContent" : true,
  "name" : "NAME_VALUE",
  "displayEndDate" : "2013-04-30T21:34:16EDT",
  "displayStartDate" : "2013-04-30T21:34:16EDT",
  "ratingType" : 293058967
}
Back to Top