API – usage of "arraySupport" parameter - Support and Troubleshooting

API – usage of "arraySupport" parameter The argument “arraySupport” can be used for XML, JSON or YAML files to uniquely identify a data item in an array.

The argument should be set to “true” (“arraySupport=true”) in the API call to display the file in an array.

With the API parameter arraySupport=true,

A CDS which has array nodes holds more metadata which is related to the array typed data. Additional fields such as "swgl_flavor_key" and "swgl_nq_name" are added in the JSON structure to the CDS which will help the parser to deal with the array typed data. These fields will be in the JSON when the parser is working and are dropped before the export. If you are applying any logic in the parser with arraySupport=true, like an iteration to run on all CDIs, then these fields should be skipped in the parser code.

Example parser logic in JavaScript

...

for (var key in node) {

if (key == "swgl_nq_name" || key == "swgl_flavor_key"){

continue;

}

...

}

...

Exampl e cURL

curl -X POST https://tenantName.sweagle.com/api/v1/tenant/metadata-parser/parse -H "Authorization: bearer aToken" --data-binary "mds={mdsName}&parser=returnDataForNode&arg=&args{args1}&mdsArgs=&format=YAML&tag=&mdsTags=&arraySupport=true"

Example Response

allowHTTPStraffic: "false"

assignedComponents:

core:

enabled: "true"

scriptExecutor:

enabled: "true"

vault:

enabled: "true"

allowHTTPtraffic: "false"

IPinternal: 10.0.0.0

deployed:

sweagleCore:

buildVersion:

buildTypeName: Sweagle_CoreMaster

buildNbr: 269