Get a Business Object by ReclD or Unique Key
You can fetch details of a business object such as a change, problem, or incident by its RecID or Unique Key.
Base URL:
https://{tenant url}/api/odata/businessobject/{business object name}({'business object unique key'})
Ensure the business object name is suffixed with an "s".
Here is an example to get a change business object by RecID or Unique Key.
URL |
https://{tenant url}/api/odata/businessobject/changes(‘02818A8426C9402E8DFE7C8D3132F783’) |
Method |
GET |
Header Name | Authorization: JWT Token/Session Key/REST API Key |
Status Code |
200 |
Response Payload |
Click to view response payload
{
} |
Unsuccessful Responses
Scenario: To fetch a particular business object instance by its ID, the value of key provided is empty or a white space.
Example:
https://{tenant url}/api/odata/businessobject/changes(‘ ‘)Header Name:
Authorization: Sessionkey
Code | ISM_4000 |
Description | Invalid Request Payload |
Message |
[ "Key value cannot be empty" ] |
HTTP STATUS CODE |
400 |
Scenario: To fetch a particular business object by its unique key, the value of key provided is random, invalid, or value of a deleted business object field.
Examples:
https://{tenant url}/api/odata/businessobject/changes(‘1234‘)
https://{tenant url}/api/odata/businessobject/changes(‘random‘)
Header Name:
Authorization: Sessionkey
Code | ISM_4000 |
Description | Invalid Request Payload |
Message |
[ "Invalid OData query" ] |
HTTP STATUS CODE |
400 |