Skip to main content
All docs
V25.1
  • UriJsonSource.PathParameters Property

    Provides access to a collection of parameters that the UriJsonSource adds to a JSON endpoint’s URI as path elements.

    Namespace: DevExpress.DataAccess.Json

    Assembly: DevExpress.DataAccess.v25.1.dll

    NuGet Package: DevExpress.DataAccess

    Declaration

    [Browsable(false)]
    public PathParameterCollection PathParameters { get; }

    Property Value

    Type Description
    PathParameterCollection

    A collection of JSON URI path parameters.

    Remarks

    This property stores a collection of path parameters that the UriJsonSource appends to a JSON endpoint’s Uri.

    The parameters are added to endpoint requests in the same order in which they are stored in the collection. Change the order of elements in the collection to reposition parameters in endpoint requests.

    Example

    The code sample below specifies a JSON endpoint and uses the date and id path parameters to identify the data record requested from the endpoint. The id path parameter is bound to the ID report parameter.

    using DevExpress.DataAccess;
    using DevExpress.DataAccess.Json;
    // ...
    // Create a new JSON source.
    var jsonSource = new UriJsonSource() {
        Uri = new Uri(@"https://localhost:44367/api/values")
    };
    // Create the "date" and "id" path parameters that are appended to the JSON URI: https://localhost:44367/api/values/date/2020-01-15/id/123/.
    jsonSource.PathParameters.AddRange(new[] {
        new PathParameter("date", typeof(String), String.Format("{0:yyyy-MM-dd}", DateTime.Today)),
        // "ID" is a report parameter whose value is used for the "id" path parameter.
        new PathParameter("id", typeof(Expression), new Expression("?ID"))
    });
    // Assign the JSON source to the data source.
    var datasource = new JsonDataSource() {
        JsonSource = jsonSource
    };
    
    See Also