# Page Settings

## Content

Report instance helps you to get the current page settings of a report, update all the page setting properties, and update a specific page setting property in a report. You can create a client application to send an HTTP request to the service application for using the report services.

### [GET] PageSettings Service Request Schema

To get the current page settings 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}/pagesettings`

| Example URL |
| ----------- |
| `https://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks /FlexCommonTasks.flxr/MultiValue DataBound Parameters$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/pagesettings ` |

**Parameters**

| **Parameter** | **Description** |
| --------- | ----------- |
| Report Full Path | Specify the full path of the executing report.<br>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 IPageSettings type object. |
| 404 | The report path or instance id does not exist. |

### [PUT] PageSettings Service Request Schema

To update all the page settings properties 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}/pagesettings`

| Example URL |
| ----------- |
| `https://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks /FlexCommonTasks.flxr/MultiValue DataBound Parameters$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/pagesettings ` |

**Parameters**

| **Parameter** | **Description** |
| --------- | ----------- |
| Report Full Path | Specify the full path of the executing report.<br>For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters |
| Instance Id | Specify the instance id of the executing report. |
| Report Page Settings | Set the page settings. Example: `paperSize=custom&height=10in&width=20.5cm` |

**Response Messages**

| **HTTP Status Code** | **Reason** |
| ---------------- | ------ |
| 200 | JSON string contains IPageSettings type object, which is the new page settings. Use the default value if one property is not set. |
| 404 | The report path or instance id does not exist. |

### [PATCH] PageSettings Service Request Schema

To update a specific page setting property 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:

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

| `Example URL` |
| ----------- |
| `https://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks /FlexCommonTasks.flxr/MultiValue DataBound Parameters$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/pagesettings ` |

**Parameters**

| **Parameter** | **Description** |
| --------- | ----------- |
| Report Full Path | Specify the full path of the executing report.<br>For example: FlexCommonTasks.flxr/MultiValue DataBound Parameters |
| Instance Id | Specify the instance id of the executing report. |
| Report Page Settings | Set the page settings. Example: `paperSize=custom&height=10in&width=20.5cm` |

**Response Messages**

| **HTTP Status Code** | **Reason** |
| ---------------- | ------ |
| 200 | JSON string contains IPageSettings type object, which is the new page settings. |
| 404 | The report path or instance id does not exist. |

For more information about Report Instances. see [WebApiExplorer Demo](https://demos.componentone.com/ASPNET/WebApiExplorer).