Find by ID
/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=KEYThe 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
-
id(required): string
The unique identifier of the object to be retrieved.
Response
- application/json
- application/xml
200 Response
-
object
Singular Resource
Title:
Singular ResourceOracle base singular resource schema definition. -
object
DataFormKey-allOf[1]
objectSingular Resourceobject-
recordId:
string
The unique record ID of the DataForm object.
-
referenceKey:
string
The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.
object-
dateAdded:
string(date-time)
The date when the DataForm object was created or added
-
dateModified:
string(date-time)
The date when the DataForm object was last modified.
-
displayEndDate:
string(date-time)
DisplayEndDate of the DataForm object
-
displayStartDate:
string(date-time)
DisplayStartDate of the DataForm object
-
emailContent:
boolean
EmailContent of the DataForm object
-
name:
string
The name of the data form. The name field can only be used for sorting.
-
ratingType:
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)
object-
questions:
array questions
To Many Relationship to Question
-
user:
UserKey
-
views:
array views
To Many Relationship to View
array-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
object-
href(required):
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:
string
Media type, as defined by RFC 2046, describing the link target.
-
method:
string
HTTP method for requesting the target of the link.
-
profile:
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel(required):
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:
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
Singular Resource
Title:
Singular ResourceOracle base singular resource schema definition. -
object
UserKey-allOf[1]
-
object
Singular Resource
Title:
Singular ResourceOracle base singular resource schema definition. -
object
DataFormQuestionKey-allOf[1]
object-
recordId:
string
The unique record ID of the DataFormQuestion object.
-
referenceKey:
string
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.
object-
dateAdded:
string(date-time)
The date when the DataFormQuestion object was created or added
-
dateModified:
string(date-time)
The date when the DataFormQuestion object was last modified.
-
isMasterIdentifier:
boolean
IsMasterIdentifier of the DataFormQuestion object
-
name:
string
Name of the DataFormQuestion object
-
required:
boolean
Required of the DataFormQuestion object
-
sortOrder:
integer
SortOrder of the DataFormQuestion object
-
specialTypeIndicator:
integer
SpecialTypeIndicator of the DataFormQuestion object
object-
answers:
array answers
To Many Relationship to Answer
-
dataForm:
DataFormKey
-
object
Singular Resource
Title:
Singular ResourceOracle base singular resource schema definition. -
object
DataFormAnswerKey-allOf[1]
object-
recordId:
string
The unique record ID of the DataFormAnswer object.
-
referenceKey:
string
The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.
object-
dateAdded:
string(date-time)
The date when the DataFormAnswer object was created or added
-
dateModified:
string(date-time)
The date when the DataFormAnswer object was last modified.
-
defaultAnswer:
boolean
DefaultAnswer of the DataFormAnswer object
-
name:
string
Name of the DataFormAnswer object
-
numberValue:
integer
NumberValue of the DataFormAnswer object
-
sortOrder:
integer
SortOrder of the DataFormAnswer object
object-
email:
string
Email of the User object
-
externalId:
integer
The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
-
externalType:
string
The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
-
name:
string
User's full name
-
recordId:
string
The unique record ID of the User object.
-
object
Singular Resource
Title:
Singular ResourceOracle base singular resource schema definition. -
object
ViewKey-allOf[1]
object-
name:
string
Localized name of the view
-
recordId:
string
GUID of the SITE table containing the view definition
-
referenceKey:
string
Non localized reference key for the view
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
}