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.
Operation | Description |
---|---|
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.
Retrieving a user story
The
operation retrieves a specific user story.getUserStory
<prodpad.getUserStory> <userStoryId>{$ctx:userStoryId}</userStoryId> </prodpad.getUserStory>
Properties
The unique identifier for a user story.userStoryId:
Sample request
Following is a sample REST/JSON request that can be handled by the getUserStory
operation.
{ "apiUrl":"https://api.prodpad.com", "apiKey":"cf7cf38d90568c184d232437c5337de25c0e2b0a1f44d3e0bbe914063d3a9ba8", "userStoryId":509090 }
Related ProdPad documentation
https://www.prodpad.com/api/get-userstories-id/
Retrieving all user stories
The
operation retrieves all user stories.listUserStories
<prodpad.listUserStories> </prodpad.listUserStories>
Sample request
Following is a sample REST/JSON request that can be handled by the listUserStories
operation.
{ "apiUrl":"https://api.prodpad.com", "apiKey":"cf7cf38d90568c184d232437c5337de25c0e2b0a1f44d3e0bbe914063d3a9ba8" }
Related ProdPad documentation
https://www.prodpad.com/api/get-userstories/
Sample configuration
Following is a sample proxy service that illustrates how to connect to ProdPad with the init
operation and use the getUserStory
operation. The sample request for this proxy can be found in the getUserStory sample request.
<?xml version="1.0" encoding="UTF-8"?> <proxy xmlns="http://ws.apache.org/ns/synapse" name="prodpad_getUserStory" 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="userStoryId" expression="json-eval($.userStoryId)"/> <prodpad.init> <apiUrl>{$ctx:apiUrl}</apiUrl> <apiKey>{$ctx:apiKey}</apiKey> </prodpad.init> <prodpad.getUserStory> <userStoryId>{$ctx:userStoryId}</userStoryId> </prodpad.getUserStory> <respond/> </inSequence> <outSequence> <send/> </outSequence> </target> <description/> </proxy>