Get a Business Object by ReclD or Unique Key

3 min

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" 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 jwt token/session key/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