Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3
typeflat

Overview

The following operations allow you to work with user stories. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with user stories, see Sample configuration

OperationDescription

Working with Users in JotForm

Retrieves a specific user story.

Working with Users in JotForm

Retrieves all user stories.

Operation details

This section provides further details on the operations related to user stories.

...

The getUserStory operation retrieves a specific user story.The getUserSubmissions operation retrieves all submissions for all the forms belonging to the account. 

Code Block
languagexml
titlegetUserStory getUserSubmissions
<prodpad.getUserStory>
	<userStoryId>{$ctx:userStoryId}</userStoryId>
</prodpad.getUserStory>
Properties

...

<jotform.getUserSubmissions>
    <limit>{$ctx:limit}</limit>
    <orderBy>{$ctx:orderBy}</orderBy>
    <offset>{$ctx:offset}</offset>
	<filter>{$ctx:filter}</filter>
</jotform.getUserSubmissions>
Properties
  • limit: The number of results in each result set for submission data.
  • orderBy: The order value in which the results are ordered.
  • offset: The page value of each result set for submission data.
  • filter: The query results to fetch a specific submissions range.
  
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getUserStory getUserSubmissions operation.

Code Block
languagexml
titleSample Request for getUserStory getUserSubmissions
{
	"apiUrl" : "https://api.prodpadjotform.com",
 	   "apiKey" : "cf7cf38d90568c184d232437c5337de25c0e2b0a1f44d3e0bbe914063d3a9ba8f71e12ef09ef7941b8b19b80e5173d26",
	"userStoryIdoffset":509090
} 
Related ProdPad documentation

...

:

...

The listUserStories operation retrieves all user stories.

Code Block
languagexml
titlelistUserStories
<prodpad.listUserStories>
</prodpad.listUserStories>

...

Following is a sample REST/JSON request that can be handled by the listUserStories operation.

Code Block
languagexml
titleSample Request for listUserStories
{
	"apiUrl":"https://api.prodpad.com "0",
	"limit" : "2",
	"apiKeyorderBy" : "cf7cf38d90568c184d232437c5337de25c0e2b0a1f44d3e0bbe914063d3a9ba8id"
}
Related ProdPad documentation

...


Info
titleNote

There are optional parameters available. For more information on the usage of these parameters please check the API document. 

Related JotForm documentation

http://wwwapi.prodpadjotform.com/apidocs/get#user-userstories/submissions

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to ProdPad JotForm with the init operation and use the getUserStory getUserSubmissions operation. The sample request for this proxy can be found in the getUserStory getUserSubmissions sample request.

Code Block
languagexml
titleSample Proxy
<?xml version="1.0" encoding="UTF-8"?>
	<proxy xmlns="http://ws.apache.org/ns/synapse" name="prodpadjotform_getUserStorygetUserSubmissions" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
	 <target>
	 <inSequence>
      <property name="apiUrl" expression="json-eval($.apiUrl)"/>
      <property name="apiKey" expression="json-eval($.apiKey)"/>
      <property name="userStoryIdlimit" expression="json-eval($.limit)"/>
      <property name="orderBy" expression="json-eval($.orderBy)"/>
      <property name="offset" expression="json-eval($.offset)"/>
      <property name="filter" expression="json-eval($.userStoryIdfilter)"/>
      <prodpad<jotform.init>
         <apiUrl>{$ctx:apiUrl}</apiUrl>
         <apiKey>{$ctx:apiKey}</apiKey>
      </prodpadjotform.init>
      <prodpad.getUserStory><jotform.getUserSubmissions>
         <limit>{$ctx:limit}</limit>
         <orderBy>{$ctx:orderBy}</orderBy>
         <offset>{$ctx:offset}</offset>
         <userStoryId><filter>{$ctx:userStoryIdfilter}</userStoryId>filter>
      </prodpadjotform.getUserStory>getUserSubmissions>
	   <respond/>
	 </inSequence>
	  <outSequence>
	   <send/>
	  </outSequence>
	 </target>
   <description/>
  </proxy>