Service Manager
Get Business Object by Filter
Fetches business object records based on the defined filter values. For example, you can define to get only active incidents.
Base URL:
https://{tenant url}/api/odata/businessobject/{business object type}?$filter={filter value}
Get Business Object by Filter - Example
Here is an example to fetch all business objects which has 'Active' Status.
| URL |
https://{tenant url}/api/odata/businessobject/incidents?$filter=Status eq 'Active' |
|
Method |
GET |
| Header Name | Authorization : Sessionkey/REST API Key |
|
Status Code |
200 |
|
Response Payload |
Click to view the response payload
{ "@odata.context": "{tenant url}/ api/odata/$metadata#incidents", "@odata.count": 53, "value": [ { "ActualCategory_Valid": "05B8C5FC8DC64DA28A8776A8D8B2C986", "ActualCategory": "Facility Security", "Category_Valid": "05B8C5FC8DC64DA28A8776A8D8B2C986", "Category": "Facility Security", "CauseCode_Valid": "", "CauseCode": "", "ClosedBy": null, "ClosedDateTime": "0001-01-01T00:00:00Z", "ClosedDuration": 0, "CreatedBy": "RThomas", "Email": "[email protected]", "FirstCallResolution": false, "Impact_Valid": "1AFFC174C7EA4AB79CCA6B15EB67006D", "Impact": "Medium", "IncidentNumber": 10435, "IsNotification": true, "IsVIP": false, "IsWorkAround": false, "LastModBy": "ATaylor", "LastModDateTime": "2019-02-14T11:05:06Z", "Phone": "+65.6829 2147", "Priority_Valid": "29CD5D78E16F4D82916C3E933A600096", "Priority": "3", "ProfileFullName": "Richard M Wright", "ProfileLink_Category": "Employee", "ProfileLink_RecID": "6EFAB27E9F164ECF96364EF18D233D26", "ProfileLink": "6EFAB27E9F164ECF96364EF18D233D26", "RecId": "05B5CD2DFAE54D86A04C74DBF616C1DE", "Status_Valid": "EAB221009EE34AB4BC1D14A42ED099AA", "Status": "Active", }, { "ActualCategory_Valid": "FB7670462FF94B77AE72445E943F6A3C", "ActualCategory": "Desktop Software", "Category_Valid": "FB7670462FF94B77AE72445E943F6A3C", "Category": "Desktop Software", "CauseCode_Valid": "", "CauseCode": "", "ClosedBy": null, "ClosedDateTime": "0001-01-01T00:00:00Z", "ClosedDuration": 0, "CreatedBy": "RThomas", "Email": "[email protected]", "FirstCallResolution": false, "Impact_Valid": "1AFFC174C7EA4AB79CCA6B15EB67006D", "Impact": "Medium", "IncidentNumber": 10409, "IsNotification": true, "IsVIP": false, "IsWorkAround": false, "LastModBy": "ATaylor", "LastModDateTime": "2019-02-14T11:05:06Z", "Phone": "+44 (0)1635 516700\r\n\r\n", "Priority_Valid": "29CD5D78E16F4D82916C3E933A600096", "Priority": "3", "ProfileFullName": "Pam J Emerson", "ProfileLink_Category": "Employee", "ProfileLink_RecID": "ACDA6CB0265D4C64A7F103AAF2906B2B", "ProfileLink": "ACDA6CB0265D4C64A7F103AAF2906B2B", "RecId": "0464AABB3FCF4EBC993D4CDC7C3EE8F4", "Status_Valid": "EAB221009EE34AB4BC1D14A42ED099AA", "Status": "Active", }, |
Unsuccessful Responses
Empty Filter Value
Scenario: Trying to fetch incidents without defining the filter value.
https://{tenant url}/api/odata/businessobject/incidents?$filter=
Header Name:
Authorization: Sessionkey
| Code | ISM_5000 |
| Description | Invalid Request |
| Message |
[ "The Filter value cannot be empty. Provide a valid value and try again" ] |
|
HTTP STATUS CODE |
500 |
Invalid Filter Value
Scenario: Trying to fetch incident with invalid filter value.
https://{tenant url}/api/odata/businessobject/incidents?$filter=Status eq 'New'
Header Name:
Authorization: Sessionkey
| Code | ISM_4000 |
| Description | Invalid Request |
| Message |
[ "Invalid Filter Value. Provide a valid Filter value and try again" ] |
|
HTTP STATUS CODE |
400 |
Was this article useful?
Copyright © 2019, Ivanti. All rights reserved.