Dictionary Parameters

Some PI Web API actions accept query string parameters of type Dictionary Parameter, representing a set of Name-Value pairs.

Dictionary Parameter Syntax

The Syntax for submitting Dictionary Parameters depends on the name of the query string parameter represented by the Dictionary Parameters:

• urlParmeterName[MyAttributeName]=MyValue

When multiple Name-Value pairs are expected, the query string parameter can be included multiple times in the same query string (see examples below). Any Dictionary Parameter names or values that include RFC3986 reserved delimiters must be percent-encoded.

Dictionary Parameter Examples

If an endpoint accepts a URL Parameter called Foo, a single Dictionary Parameter could be provided with this sample URL query:

• ?Foo[Name1]=Value1

If an endpoint accepts a URL Parameter called Bar, multiple Dictionary Parameters could be provided with this sample URL query:

• ?Bar[City]=London&Bar[StartTime]=1-1-2017 00:01:00.123