Get a list of stream data records.

 

Prerequisites

• Your unique Tenant ID, obtained from support.
• Your unique apiKey, as generated in Company Info.
• The stream ID​, taken from the stream Summary page.

Details

​

Method: GET

URL: https://us.pulpstream.com/vfr/api/streamRecords?{queryParameters}

 

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

Content-Type: application/json

​

Query Parameters:

By default, the API returns all records for all streams.
Use the query parameters to restrict the results to a single stream, and to filter and order the records.

Separate parameters with the & sign.
Sample parameters:

• startPosition=0&maxRecords=200
    Returns records 1..200.
  For the second 200, specify startPosition=201, maxRecords=400.
  And so on.
   
  
• filters=[{lhs:'streamTemplateId';operator:'=';rhs:'yourStreamId'}]
  Selects records for your specified stream ID.
   
  
• orderBy=[{'attribute':'dateCreated';'order':'desc'}]
  The orderBy line orders the results by date created, in descending order.
  (Use "asc" for ascending.)

Response:

Here is a sample response:

{
 "message":"",
 "responseBody":[          // start of record list
 {
   "id":"589...4d7c0",     // ID of first record
   "streamTemplateId":"d5b...c325",
   "name":"Incident Management",
    ...
   "string1":              // text field ("string1" would be field name)
   "intnumber1":0,         // integer field
   "double1":0.0,          // decimal field
   "date1":null,           // date field

   "boolean1":false,       // checkbox field
   "smartObject1":null,    // reference to another smart object record
   "smartObject1Name":     // display name for the referenced record
    ...
   "dateCreated":"2016-04-29T06:40:31.000+0000",
   "createdBy":"2d07...f71f67",
   "createdByMap":null,
   "dateModified":null,
   "modifiedBy":null,
   "userObject1":null,
   "userObject1Name":null,
   "locationId":null
 },
 {
   "id":"4c7...eefe", // record ID #2
   ...record fields...
 },
 ...more records...
 ]

}

 

 

​