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 RecID/object unique key}

Get a Business Object by RecID or Unique Key - Example

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 : Sessionkey/REST API Key
Status Code	200
Response Payload	Click to view response payload { "@odata.context": "https://frs-dev-tenant.saasitdev.com/api/odata/change/$metadata#changes/$entity", "AcceptanceDueDate": "0001-01-01T00:00:00Z", "AcceptTimeout": "0001-01-01T00:00:00Z", "BackoutPlanAttached": false, "BallotCount": null, "BusinessFunction_Valid": "", "BusinessFunction": "", "Category_Valid": "E0234286776B43C39231635C7066F369", "Category": "Software", "ChangeNumber": 10173, "ClosedBy": null, "ClosedCode_Valid": "", "ClosedCode": "", "ClosedDateTime": "0001-01-01T00:00:00Z", "CompletedBy": "", "CreatedBy": "Admin", "RecId": "008E3506AF3F4CC190BC95523645D968", "RiskLevel_Valid": "3548D4C1230B491DAB1D315AA93902B5", "RiskLevel": "Low", "RiskCatalogLink_Category": "", "RiskCatalogLink_RecID": "", "RiskCatalogLink": null, "ReleaseLink_Category": "", "ReleaseLink_RecID": "", "ReleaseLink": "", "TriggerChangesToCI": "0001-01-01T00:00:00Z", "RequesterLocation": "APAC - China", "RequesterPhone": "+86 10 8520 0424", "MCVoteExpirationDateTime": "0001-01-01T00:00:00Z", "ECABVoteExpirationDateTime": "0001-01-01T00:00:00Z", "CABVoteExpirationDateTime": "2011-10-14T01:30:36+05:30", "SubmissionDeadLineDateTime": "2011-10-07T13:46:00+05:30", "CABReviewDate": "2011-10-14T01:30:36+05:30", "RiskTotalScore": null, "ReadOnly": false, "OwnerFullName": null, "Cost": 182, "TotalTimeSpent": 160, "IsUnRead": false }

Unsuccessful Responses

Empty Object ID

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

Invalid Object ID

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

Was this article useful?

Privacy and Legal