ComponentOne Studio Web API Edition
Parameters
Services > Report Services > Report Instances > Parameters

Report instance helps you to fetch the parameter descriptions for a specified report, update the value of all the parameters in the report, update a specific parameter in the report and fetch information of a specific parameter using a parameter name. You can create a client application to send an HTTP request to the service application for using the report services.

[GET] Parameters Service Request Schema

To get the parameters in the report instance with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as follows:

GET: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

Example URL
Copy Code 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/parameters

Parameters

Parameter Description
Report Full Path Specify the full path of the executing report.
For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id Specify the instance id of the executing report.

Response Messages

HTTP Status Code Reason
200 JSON string contains a collection of IParameter.
404 The report path does not exist.

Back to Top

[PUT] Parameters Service Request Schema

To update all the parameter values in the report instance with the specified instance id, you need to use PUT method. Report full path and instance id of executing report is specified in the request URL, as follows:

PUT: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

Example URL
Copy Code 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/parameters

Parameters

Parameter Description
Report Full Path Specify the full path of the executing report.
For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id Specify the instance id of the executing report.
Report Parameters Check the response of action parameters. Example: pCategory=1&...

If the parameter is multi-value, set the parameters multiple times. Example: pCategory=1&pCustomers=3&...

Response Messages

HTTP Status Code Reason
200 JSON string contains a collection of IParameter interface. New parameters with validation.
404 The report path or instance id does not exist.

Back to Top

[PATCH] Parameters Service Request Schema

To update a specific parameter value in the report instance with the specified instance id, you need to use PATCH method. Report full path and instance id of executing report is specified in the request URL, as follows:

PATCH: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

Example URL
Copy Code 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/parameters

Parameters

Parameter Description
Report Full Path Specify the full path of the executing report.
For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id Specify the instance id of the executing report.
Report Parameters Check the response of action parameters. Example: pCategory=1&...

If the parameter is multi-value, set the parameters multiple times. Example: pCategory=1&pCustomers=3&...

Response Messages

HTTP Status Code Reason
200 JSON string contains a collection of IParameter interface. New parameters with validation.
404 The report path or instance id does not exist.

Back to Top

[GET] Parameters Service Request Schema

To get the parameter using a specific parameter name in the report instance with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as follows:

GET: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}

Example URL
Copy Code 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/20f8e7c7-ea84-4961-81f7-5b8ff662f588/parameters/pCategory

Parameters

Parameter Description
Report Full Path Specify the full path of the executing report.
For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id Specify the instance id of the executing report.
Parameter Name Specify the parameter name. For example: pCategory

Response Messages

HTTP Status Code Reason
200 JSON string contains IParameter type object.
404 The report path or instance id does not exist.

Back to Top

[PUT] Parameters Service Request Schema

To get the parameter using a specific parameter name in the report instance with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as follows:

PUT: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}

Example URL
Copy Code 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/20f8e7c7-ea84-4961-81f7-5b8ff662f588/parameters/pCategory

Parameters

Parameter Description
Report Full Path Specify the full path of the executing report.
For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id Specify the instance id of the executing report.
Parameter Name Specify the parameter name. For example: pCategory
Parameter Values Specify the report parameter values.

Response Messages

HTTP Status Code Reason
200 JSON string contains a collection of IParameter interface. New parameters with validation.
404 The report path or instance id does not exist.

For more information about Report Instances. see WebApiExplorer Demo.

Back to Top

 

 

Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback