Tag value should be more flexible to allow REST Response JSON example to handle multiple values for a property

See this idea on ideas.ibm.com

Currently, the IlrTag value is set to a String.
Because of this, when setting multiple values to a property, then retrieving this value with REST API:
/v1/projects/{projectId}/rules
the result is a single string with the multiple values as one comma separated string, rather than a proper structured JSON Object with multiple values.
This undermines the accuracy and usage of the REST APi's itself.

Idea priority

Medium

Post comment

Admin
Antony Viaud

Reply
| Mar 18, 2025
Hello, we could consider using a JSON array of key-value pairs but both key and value attribute would remain strings :
```
{
"name": "tags",
"value": [ 
{ "key": "TransportMode", "value": "Sea,Air" },
{ "key": "RuleRef", "value" : "257231" }
]
"label": "Tags"
},
```
Other clients may have intentionally included commas into the value, without being a separator for a list.
1 reply Hide replies

Guest

Reply
| Mar 17, 2025
Tags are a list with Key and value pairs. The current design of the DC Rest API's does not treat tags as list causing problematic parsing of the key and values .
In the example below the value of the Tag : such as Air, Sea are legit data values indicating the transport type is both Air and Sea separated by comma. This is now a multiple value is represented. Not an accidental typo
```
Tag1:
Key=TransportMode
Value=Sea,Air

Tag2:
Key=RuleRef
Value=257231

This comes through in JSON REST Response as 
{
"name": "tags",
"value": "{ TransportMode=Sea,Air, RuleRef=257231}",
"label": "Tags"
}, 
```
This JSON Structure is problematic because the value field contains custom key-value format inside a string, rather than a proper structured JSON Object.

Your developers need to correctly format the JSON structure for value attribute as a JSON Object or an array of key-value pairs instead of a single string.

There are two ways to do this based on your developer's preference
Option1: Use a JSON Object for Key-Value Pairs
```
{
"name": "tags",
"value": { 
"TransportMode": ["Sea", "Air"],
"RuleRef" : "257231"
}
"label": "Tags"
},
```
In the example above value is now an array ["Sea", "Air"] preserving multiple values property

Option2: Use an Array of Key-value Objects
```
{
"name": "tags",
"value": [ 
{ "key": "TransportMode", "values": ["Sea", "Air"] },
{ "key": "RuleRef", "values" : ["257231"] }
]
"label": "Tags"
},
```
The above approach works well when value has multiple key-valye pairs with multiple values per key.

Either way the current structure is problematic because
- The value is currently shown as string not a JSON object
- Parsing value manually is error prone.
- Comma-separated values inside s string makes key-value extraction difficult
Regards
Jatin
0 reply Hide replies

By clicking the "Post Comment" or "Submit Idea" button, you are agreeing to the IBM Ideas Portal Terms of Use.
Do not place IBM confidential, company confidential, or personal information into any field.

Shape the future of IBM!

Search existing ideas

Post your ideas

Please use the following category to raise ideas for these offerings for all environments (traditional on premises, containers, on cloud):

Specific links you will want to bookmark for future use

Tag value should be more flexible to allow REST Response JSON example to handle multiple values for a property

Please enter your email address

RELATED IDEAS

Tag value should be more flexible to allow REST Response JSON example to handle multiple values for a property