Create a new stream record in the system, and launch its associated process.

 

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.
  Also known as the "stream template ID", in the APIs. 
  Important:
  When a new version of a stream is published, the stream template ID stays the same. 
  The API will always use latest version of the stream.

• Data Component Names
  The internal names of any stream data components to which data will be submitted,
  taken from the data-component definition pages.

Details

​

Method: POST

URL: https://us.pulpstream.com/vfr/api/streamRecords

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

Content-Type: application/json

apiUserName: Optional. Specify internal username from the User definition to submit the data on behalf of that user.

PayLoad:

{

   "streamTemplateId":"be8……….a8fb", // the stream ID

   "submit":true,                    // should always be true, to submit the form data

   "documentData":{

      "StreamDataComponentName1":{   // the name of a data component defined in the stream

         "FieldName1":"field data",  // specify internal field names, not display labels

         "FieldName2":"field data",

         "Date_of_Incident":"2021-05-22T00:00:00",
         "Time_of_Incident":"11:12 am",

         "Submitter":"",             // defaults to user with matching email address

      }

      "StreamDataComponentName2":{   // Multiple data components can be specified
       ...

      }

      ...

   }

}

​

Response:

{

    "message": "",

    "responseBody": "1595........................dfad" // id of generated record

}

 

Notes 

• Any data component present in the Stream Definition can be specified using the component name.
• Within the documentData section of the payload, any fields that are part of the data component can be specified.

Data Formats​

• User fields - Supply User ID or the internal username taken from the User definition.
• Date and Time fields - Supply value using ISO-8601 format in the time zone specified in company information.
• Photo or File Fields - First upload the file(s) using the File Upload API.
  The returned value for each uploaded file can then be added to the 
  File List or Image List  field defined in the stream.
  For example: Accident_Photos:['341231231231231_Incident.JPG', ...] 

​