Read
This content applies to legacy components (such as K2 Studio and K2 for Visual Studio), legacy assemblies , legacy services or legacy functionality. If you have upgraded from K2 blackpearl 4.7 to K2 Five , these items may still be available in your environment. These legacy items may not be available in new installations of K2 Five . These legacy items may also not be available, supported, or behave as described, in future updates or versions of K2. Please see the legacy component support policy for more information about support for these components.
Executes the Read type method on the SmartObject, using the relevant Key value, and returning the SmartObject as XML.
The Read method requires the record ID in the Query Options of the URL.
| Value | Notes | |
|---|---|---|
| URI | {Service Root URI}{Service Path}?{SmartObjectKey}&{Query Options} Example: http://k2.denallix.com:8888/SmartObjectServices/REST/Samples/Employee/Load?Id=1 |
See URIs for REST Services |
| Method | GET | |
| Request Headers | Content-type: application/xml | Ensure that the request has the correct Content-type set |
| Query Options | Typically, the record ID of the record to load, using the name of the key property for the record. Example: ?Id=1 |
Query options will be different depending on the definition of the SmartObject. You can use the EndPoints.xml address as discussed in SmartObject REST Services to explore the query options for the specific endpoint you wish to use. |
| Request Body | (not applicable) |
|
| Return Type | The SmartObject record as a XML string, or Errors and Response Codes Example return data for a hypothetical Employee SmartObject: |