OpenAPI for Excel

OpenApiGet functions require instructions on which FieldGroups and Fields are returned in Excel/VBA, the later of which is encoded in the ParameterList:

This list is a simple case-sensitive, comma-separated string with full stops identifying nested sub-elements. The FieldGroups query string parameter controls which data is returned in the response body. For instance, suppose we are interested in pulling out the NetPositionView FieldGroup for the current client's account, and from this FieldGroup we select the ExposureInBaseCurrency field, alongside the default NetPositionId field (as before). Using AutoResize functionality, which parses the returned data automatically into a correctly-sized Excel array, the corresponding Excel formula is structured as follows:

=OpenApiGetAutoResize("/openapi/port/v1/netpositions/me/?FieldGroups=netpositionview",
"NetPositionId,NetPositionView.ExposureInBaseCurrency",TRUE)

Which returns:

Fields from FieldGroups that are not included in the query string parameters will return blanks. Suppose the field DisplayAndFormat.Description is added to the ParameterList, without calling the corresponding FieldGroup:

=OpenApiGetAutoResize("/openapi/port/v1/netpositions/me/?FieldGroups=netpositionview",
"NetPositionId,NetPositionView.ExposureInBaseCurrency,DisplayAndFormat.Description",TRUE)

Which fails to pull the required data because the Description field is not found in the netposititonsview FieldGroup.

Adding the DisplayAndFormat FieldGroup fixes this issue:

=OpenApiGetAutoResize("/openapi/port/v1/netpositions/me/?FieldGroups=netpositionview,displayandformat",
"NetPositionId,NetPositionView.ExposureInBaseCurrency,
DisplayAndFormat.Description",TRUE)