Get All Business Objects
Fetches all records for the specified business object type.
Base URL:
https://{tenant url}/api/odata/businessobject/{business object name}
Ensure the business object name is suffixed with an "s".
Here is an example to fetch all business objects of incident type.
URL |
https://{tenant url}/api/odata/businessobject/incidents |
Method |
GET |
Header Name | Authorization: JWT Token/Session Key/REST API Key |
Status Code |
200 |
Response Payload |
Click to view response payload
{ "@odata.context": "https://{tenant url}/api/odata/$metadata#incidents", "@odata.count": 44, "value": [ { "ActualCategory_Valid": "14348C1FFA044D8AB1E93005B4A0A287", "ActualCategory": "Missing Item", "Category_Valid": "14348C1FFA044D8AB1E93005B4A0A287", "Category": "Missing Item", "CauseCode_Valid": "E2489F3F7DA34B898CCD9569CA5541F2", "CauseCode": "Other", "ClosedBy": "JClerk", "CreatedBy": "JClerk", "RecId": "003B58C0B4554E4BAA30DFD88876582A", "LoginId": "KDavidson", "Owner_Valid": "5918944FE08C4F088C5E02E27DB7C6E3", }, { "ActualCategory_Valid": "71754AC55675467B8BEDE187DEC5D392", "ActualCategory": "Backup", "Category_Valid": "71754AC55675467B8BEDE187DEC5D392", "Category": "Backup", "CauseCode_Valid": null, "CauseCode": null, "ClosedBy": null, "CreatedBy": "FRS_QA", "RecId": "013CCF80552C43F881BE6741981CFEB7", "LoginId": "AGreen", }, |
The data displayed in the Response Payload is only a sample data, it does not contain the full list of responses but only a few are shown for sample.
Unsuccessful Response
Scenario: Trying to fetch business objects of type incidents with invalid url.
Valid URL:
https://{tenant url}/api/odata/businessobjects/incidents
Invalid URL Examples:
https://{tenant url}/api/odata/businessobjects/incident
https://{tenant url}/api/odata/businessobjects/ incident
https://{tenant url}/api/odata/businessobjects/ incidents
Header Name:
Authorization: Sessionkey
Code | ISM_4004 |
Description | Not Found |
Message |
[ "Requested resource not found" ] |
HTTP STATUS CODE |
404 |