GET api/Portal/HCWorkOrderTable
Load Work Orders table data.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
draw | integer |
None. |
|
start | integer |
None. |
|
length | integer |
None. |
|
order | Collection of IBMS_Cloud_API.Output+TableOrder |
None. |
|
search | IBMS_Cloud_API.Output+TableSearch |
None. |
|
columns | Collection of IBMS_Cloud_API.Output+TableColumns |
None. |
Body Parameters
None.
Response Information
Resource Description
IBMS_Cloud_API.Output+TableResponseName | Description | Type | Additional information |
---|---|---|---|
draw | integer |
None. |
|
recordsTotal | integer |
None. |
|
recordsFiltered | integer |
None. |
|
data | Object |
None. |
|
error | string |
None. |
|
columnFilters | Collection of IBMS_Cloud_API.Output+TableColumnFilters |
None. |
Response Formats
application/json, text/json
Sample:
{ "draw": 1, "recordsTotal": 2, "recordsFiltered": 3, "data": {}, "error": "sample string 5", "columnFilters": [ { "columnName": "sample string 1", "items": [ { "label": "sample string 1", "value": "sample string 2" }, { "label": "sample string 1", "value": "sample string 2" } ] }, { "columnName": "sample string 1", "items": [ { "label": "sample string 1", "value": "sample string 2" }, { "label": "sample string 1", "value": "sample string 2" } ] } ] }
text/html
Sample:
{"draw":1,"recordsTotal":2,"recordsFiltered":3,"data":{},"error":"sample string 5","columnFilters":[{"columnName":"sample string 1","items":[{"label":"sample string 1","value":"sample string 2"},{"label":"sample string 1","value":"sample string 2"}]},{"columnName":"sample string 1","items":[{"label":"sample string 1","value":"sample string 2"},{"label":"sample string 1","value":"sample string 2"}]}]}
application/xml, text/xml
Sample:
<Output.TableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API"> <columnFilters> <Output.TableColumnFilters> <columnName>sample string 1</columnName> <items> <Output.TableColumnFilterValues> <label>sample string 1</label> <value>sample string 2</value> </Output.TableColumnFilterValues> <Output.TableColumnFilterValues> <label>sample string 1</label> <value>sample string 2</value> </Output.TableColumnFilterValues> </items> </Output.TableColumnFilters> <Output.TableColumnFilters> <columnName>sample string 1</columnName> <items> <Output.TableColumnFilterValues> <label>sample string 1</label> <value>sample string 2</value> </Output.TableColumnFilterValues> <Output.TableColumnFilterValues> <label>sample string 1</label> <value>sample string 2</value> </Output.TableColumnFilterValues> </items> </Output.TableColumnFilters> </columnFilters> <data /> <draw>1</draw> <error>sample string 5</error> <recordsFiltered>3</recordsFiltered> <recordsTotal>2</recordsTotal> </Output.TableResponse>