Settings¶

Request settings for a user.

HTTP Request¶

GET /icweb.dll/setting/{category}/{subcategory}/{identifier}/{source}

URI Parameters¶

Name	In	Required	Type	Description
`category`	Path	No	String	Specifies the category to retrieve the Setting objects for. Common values: Form, Grid, Options, Tree, Window.
`subcategory`	Path	No	String	Specifies the sub category to retrieve the Setting objects for. Value here is related to category, Form, Grid, Tree and Window usually use the subcategory relating to the name of the business object. For example ‘Asset Location’.
`identifier`	Path	No	String	Specifies the identifier to retrieve the Setting objects for, `identifier` refers to the specific item, such as focusedRow, layout, selectedItes, expandedNodes for grid/tree `category` items.
`source`	Path	No	String	Specifies the source to retrieve the Setting objects for, source is used to differentiate the setting on use. For example for Grid/Tree, a blank source refers to the defaults for that Grid/Tree, ‘Selector’ is used in source when the Grid/Tree is within a selection dialog.

Responses¶

Name	Type	Description
200 OK	Setting []	One or more settings matching search criteriea.

Setting¶

The Setting object, contains information about the setting.

Name	Type	Optional	Description
`category`	String	No	Specifies the category of this setting, common values: Form, Grid, Options, Tree, Window.
`subcategory`	String	No	Specifies the sub category of this setting, value is related to category: Form, Grid, Tree and Window usually use the subcategory relating to the name of the business object. For example ‘Asset Location’.
`identifier`	String	No	Specifies the identifier of this setting, `identifier` refers to the specific item, such as focusedRow, layout, selectedItes, expandedNodes for grid/tree `category` items.
`source`	String	Yes	Specifies the source to retrieve the Setting objects for, source is used to differentiate the setting on use. For example for Grid/Tree, a blank source refers to the defaults for that Grid/Tree, ‘Selector’ is used in source when the Grid/Tree is within a selection dialog.
`value`	String	Yes	Specifies the value for the setting. For complex settings this may contain JSON within a string, that may have to be parsed.
`defaultValue`	String	Yes	Specifies the default value for the setting. This is used if `value` is null.

Example¶

Retrieve the all settings for the Grid associated with ‘Anomaly’

Request¶

GET /icweb.dll/setting/Grid/Anomaly

Response¶

[{
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "expandedNodes",
                "value": "-1073741841,-1073741851"
        }, {
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "filters",
                "value": "{}"
        }, {
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "focusedRow",
                "value": "-1073741832"
        }, {
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "groupedColumns",
                "value": "Closed_Out,Code_ID"
        }, {
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "layout",
                "value": "{\"columns\":[{\"fieldName\":\"AC_ID\",\"order\":19,\"visible\":false},{\"fieldName\":\"AS_ID\",\"order\":15,\"visible\":true},{\"fieldName\":\"Action_Overdue\",\"order\":21,\"visible\":false},{\"fieldName\":\"Action_Status\",\"order\":22,\"visible\":false},{\"fieldName\":\"Anomaly_ID\",\"order\":0,\"visible\":false},{\"fieldName\":\"Anomaly_No\",\"order\":13,\"visible\":true},{\"fieldName\":\"Asset_Location\",\"order\":3,\"visible\":false},{\"fieldName\":\"Asset_Type\",\"order\":7,\"visible\":true},{\"fieldName\":\"Assigned_To_ID\",\"order\":2,\"visible\":false},{\"fieldName\":\"CV_ID\",\"order\":1,\"visible\":false},{\"fieldName\":\"Closed_Out\",\"order\":9,\"visible\":true},{\"fieldName\":\"Code_ID\",\"order\":12,\"visible\":true},{\"fieldName\":\"Comments\",\"order\":20,\"visible\":false},{\"fieldName\":\"Component_ID\",\"order\":6,\"visible\":true},{\"fieldName\":\"Created_By_ID\",\"order\":18,\"visible\":true},{\"fieldName\":\"Date_Created\",\"order\":17,\"visible\":true},{\"fieldName\":\"Date_Found\",\"order\":23,\"visible\":false},{\"fieldName\":\"Description\",\"order\":11,\"visible\":true},{\"fieldName\":\"Most_Recent_Workpack\",\"order\":24,\"visible\":false},{\"fieldName\":\"Name\",\"order\":4,\"visible\":true,\"sortIndex\":0,\"sortDirection\":\"Ascending\"},{\"fieldName\":\"Original_Workpack\",\"order\":25,\"visible\":false},{\"fieldName\":\"Primary_Asset\",\"order\":26,\"visible\":false},{\"fieldName\":\"Ref_No\",\"order\":16,\"visible\":true},{\"fieldName\":\"Risk_ID\",\"order\":5,\"visible\":true},{\"fieldName\":\"Risk_Score\",\"order\":10,\"visible\":true},{\"fieldName\":\"Severity_ID\",\"order\":14,\"visible\":true},{\"fieldName\":\"Status_ID\",\"order\":8,\"visible\":true}]}"
        }, {
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "selectedItems",
                "value": "6"
        }
]

Update Settings¶

Update settings for a user.

HTTP Request¶

POST /icweb.dll/setting/

URI Parameters¶

Name	In	Required	Type	Description
`settings`	Body	Yes	Setting []	Specifies the list of settings to update/save for the current user.

Responses¶

Name	Type	Description
200 OK

Example¶

Create/update a setting for Grid -> Anomaly. Request ^^^^^^^

POST /icweb.dll/setting/

Body¶

[
    {
                "category": "Grid",
                "subCategory": "Anomaly",
                "identifier": "selectedItems",
                "value": "6"
        }
]

Setting Value Json Format¶

The following provides a base specification for the JSON that may be included for different settings.

Grid / ? / Layout¶

Name	Required	Type	Description
`columns`	Yes	Grid Column []	Specifies the list of settings for a grid/tree.

Grid Column¶

Name	Required	Type	Description
`fieldName`	Yes	String	Name of the field from the BusinessObject that this column refers to.
`order`	Yes	Integer	Display index of the column. 0 denotes the left-most column in the grid/tree.
`visible`	Yes	Boolean	Is the column visible in the grid/tree.
`sortIndex`	No	Integer	If specified, this column is being to specify the sorting in the grid, multiple columns can be specified, the index is 0 based, and denotes the first column to sort upon, followed by 1 etc.
`sortDirection`	No	String	Specifies the sort direction for the column, either `Ascending` ie A thru Z (0 thru 9), or `Descending` ie Z thru A (9 thru 0).