List
Executes the List type method on the SmartObject returning a collection of the SmartObject items.
The List method optionally allows a SmartObject key field to be passed in via the query parameters in the URL. The SmartObject Key will indicate the single record to return (effectively, a 'Read' operation to return a single record). If you need to pass in a multi-field key, you can pass in multiple properties separated by ampersand (&), for example Id=100&Code=AZ2.
| Value | Notes | |
|---|---|---|
| URI | {Service Root URI}{Service Path}?{Query Options} Example: http://k2.denallix.com:8888/SmartObjectServices/REST/Samples/Get%20List?format=xml |
See URIs for REST Services and System Query Options |
| 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 records as a array or XML nodes, or Errors and Response Codes Example return data for a hypothetical Employee SmartObject: |