Read CustomView

Retrieves the details of a CustomView object that has been previously created.

Parameters

Path Params

yourCompany:

string
The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/CustomView will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/CustomView

Query Params

filter:

string
In this parameter Module name needs to be provided to fetch related details.for eg. module=Products

  1. To fetch CustomView for Products module, the following url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/CustomView?module=Products&key=xyzkey

Header Params

Accept:

string
Response header need to be passed for eg. application/json or application/xml.

Query Auth

key:

string
API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth

apiKey:

string
Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Response

{
    "Customviews": {
        "Customview": [
            {
                "CustomviewId": "1",
                "Module": "Products",
                "CustomviewName": "Wholesale"
            },
            {
                "CustomviewId": "2",
                "Module": "Products",
                "CustomviewName": "Retail"
            }
        ],
        "TotalRecords": "2",
        "CurrentPage": "1",
        "TotalPages": "1",
        "PageSize": "50"
    }
}
<Customviews>
    <Customview>
        <CustomviewId>1</CustomviewId>
        <Module>Products</Module>
        <CustomviewName>Wholesale</CustomviewName>
    </Customview>
    <Customview>
        <CustomviewId>2</CustomviewId>
        <Module>Products</Module>
        <CustomviewName>Retail</CustomviewName>
    </Customview>
    <TotalRecords>2</TotalRecords>
    <CurrentPage>1</CurrentPage>
    <TotalPages>1</TotalPages>
    <PageSize>50</PageSize>
</Customviews>

© Copyright 2022 Agiliron - All Rights Reserved.