Progress® Telerik® Reporting R3 2017

Get Report Parameters

Request

URI Template
POST /api/reports/clients/{clientId}/parameters

Path parameters

NameTypeDescription

clientId

String

ID of the service client. Returned from Register Client.

Request Body

ReportSource object. Represent a report and its current parameter values.

Response

HTTP Status CodeDescription

200 OK

Report instance successfully created

400 BadRequest

No report name is specified

404 Not Found

The specified report name cannot be resolved / Parameter values are not valid

410 Gone

The specified clientId cannot be found (expired)

Response Body

Array containing Parameter objects representing the report parameters that should be used to prompt the user.

Sample

Request Message
POST /api/reports/clients/2c3d/parameters HTTP/1.1

{
  report: “MyReport1”,
  parameterValues: {
        ‘p1’: ‘v1’,
        ‘p2’: 20
  },
}
Response Message
HTTP/1.1 200 OK

[
    { 
      ‘name’: ‘p1’,
      ‘id’: ‘p1’,
      ‘type’: ‘System.Integer’,
      ‘text’: ‘Input p1’,
      ‘multivalue’: false,
      ‘allowNull’: true,
      ‘allowBlank’: false,
      ‘isVisible’: true,
      ‘autoRefresh’: false,
      ‘hasChildParameters’: true,
      ‘childParameters’: [‘p2’],
      ‘value’:1
      ‘label’: ‘1’,

    },
    { 
      ‘name’: ‘p2’,
      ‘id’: ‘p2’,
      ‘type’: ‘System.String’,
      ‘text’: ‘Please input p2’,
      ‘multivalue’: false,
      ‘allowNull’: false,
      ‘allowBlank’: false,
      ‘isVisible’: true,
      ‘autoRefresh’: false,
      ‘hasChildParameters’: false,
      ‘availableValues’: [ 
              {‘name’: ‘Sofia’, ‘value’: ‘Sofia’}
              {‘name’: ‘Berlin’, ‘value’: ‘Berlin’}
      ],
      ‘value’: ‘Sofia’
      ‘label’: ‘Sofia’,
    }
]