Configure the pivot values API in FireForm

On this page:

Overview
Configuration
Expected input parameters
Example
Return values
Get help

Overview

The Form Pivot Value (Put) API updates pivot value entries based on a pivot set ID, and optionally lets you update the value, parent value, assignees, groups, email address, or sort order. All pivot values associated with the pivot set can be updated with this API.

Note:

To request API access for your FireForm tenant, submit a FireForm API Access Request.

Configuration

To configure this API, see /api/v1/forms/pivot/value on the FireForm API page.

Expected input parameters

Parameter	Description	Format	Required (Y/N)
PivotSetId	Unique identifier for each pivot set	GUD	Y
Value	Name of the value associated to the pivot set	Alphanumeric (250 characters max)	N
ParentValue	Name of the value that has one or more child values	Alphanumeric (250 characters max)	N
Assignees	Usernames of individuals assigned to take action on a given form at its current step	List of Network IDs separated by commas (2,000 alphanumeric characters max)	N
Groups	Grouper Group names assigned to take action on a given form at its current step	List of Grouper Group names separated by commas (2,000 alphanumeric characters max)	N
EmailAddresses	List of email address what will receive a copy of the respondent confirmation email	List of email addresses separated by commas (2,000 alphanumeric characters max)	N
SortOrder	Order in which the values will be displayed in the online interface	Numeric	N
TranslateJSON	Used to bind form elements to an external endpoint in the integration process	JSON object	N

Example

Example input

{
  "PivotSetId": "CD9F041D-F2B7-4478-D8D9-08D7062E5E3C",
  "Values": [
    {
      "Value": "2020202",
      "ParentValue": "1010101",
      "Assignees": [
        "ashbush",
        "tdlewis"
      ],
      "Groups": [
        "Product Pushers PO",
        "Product Pushers Dev",
      ],
      "EmailAddresses": [
        "janedoe@iu.edu",
        "johndoe@iu.edu",
      ],
      "SortOrder": 2,
      "TranslateJSON": {
        "fiscalOfficer": "johndoe",
        "delegate": "janedoe",
        "dept": "VPIT"
      }
    }
  ]
}

Example return

Returns no content when successful.

Return values

Expected return data