This is the second in a series of practice exercises to help you
become familiar with Cherwell's REST API Discovery Tool. We highly recommend
that you complete the following exercises before you begin:
In this exercise, you will call the Get Business Object Summary
operation to get the Business Object ID for Incident. Then, you will use the
Business Object ID to call the Get Business Object Schema operation.
Get the Business Object
ID:
- Log into the REST API Discovery Tool. See
Opening the REST API Discovery Tool.
- Click the
Business Objects heading to expand the list of
operations.
- Click
/api/V1/getbusinessobjectsummary/busobname/{busobname}
to expand the operation's details.
- Under parameters, type Incident for the busObName parameter.
- Click
Try it out!
If the response data does not appear, ensure that the
authentication button has been switched to
On.
- From the response body, copy the value for busObId. This is the
Business Object ID that you will use to call the next operation.
Use the Business Object ID to
get the Business Object schema:
- Click
/api/V1/getbusinessobjectschema/busobid/{busobid}
to expand the operation's details.
- Under parameters, paste the Business Object ID in the busObId
Value field.
- Select
false for the includeRelationships parameter
so that the response data will not include information about related Business
Objects.
- Click
Try it out!
- Optional:
Try calling the operation again using a different Business Object
ID or including information about related Business Objects.