Expand my Community achievements bar.

The Community Advisors application is now OPEN for the second class of 2024. Apply to become a part of this exclusive program!

Add Association Between Custom Form Sections (parameterGroup) to Custom Form Values (parameterValues)

Avatar

Level 1

5/25/23

I would like to be able to retrieve the custom form values (parameterValues), given a custom form section (categoryParameter) name or ID. 

 

Currently, the API allows for Custom Form Names to be retrieved from a given Custom Form using the following api call:

/proj/[projectID]/search?fields=objectCategories:category:categoryParameters:parameterGroup

 

There is also an, unsupported, api call that allows for a "data dump" of all values in a given custom form, using the following api call:

/proj/[projectID]/search?fields=*,parameterValues

 

I would think that the "parameterValues" object would need to be added to the "parameterGroup" object.

{
    "data": {
        "ID": "",
        "name": "",
        "objCode": "PROJ",
        "objectCategories": [
            {
                "ID": "",
                "objCode": "OBJCAT",
                "category": {
                    "ID": "",
                    "name": "",
                    "objCode": "CTGY",
                    "categoryParameters": [
                        {
                            "objCode": "CTGYPA",
                            "parameterGroup": {
                                "ID": "",
                                "name": "",
                                "objCode": "PGRP",								
								"parameterValues":{
									"[customFormName]":"[value]"
								}
                            }
                        }
					}
			}
		]	
	}
}

If that isn't possible, maybe a simple GET call to get the "parameterValues" by a "parameterGroup" Name or ID.

 

 

 

This is important to our business because we use custom forms to integrate many systems. At times, these custom forms are very large and have many sections within them. We would like the ability to separate logic base on values from a given section with a custom form in order to keep scenario blueprints to a manage, maintainable size.

 

Currently we are unable to separate logic in a scenario, based on custom form sections, within large custom forms bases on values from a given section with a custom form.

1 Comment

Avatar

Community Advisor

5/29/23

This is maybe a bit too unwieldy, but if you haven't thought of this, you could try this.

1. Pull the custom properties on your target custom form

2. Repeat as many times as necessary for however many forms you want

3. Create comma-seperated list string of all property names that you want values for

4. Use list of properties from 3 to craft your GET request for your target(s)