Create a Business Object
You can create business objects available out-of-the-box, such as a Change, Problem, Incident, or any custom defined business object of your choice.
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 create a change business object.
You can create any other business object of your choice by following the example but ensure you provide the appropriate business object name suffixed with "s" in the businessobject place holder in the URL and enter relevant details in the Request Payload.
URL | https://{tenant url}/api/odata/businessobject/changes |
Method |
POST |
Header Name | Authorization: JWT Token/Session Key/REST API Key |
Request Payload |
Click to view the Request Payload
{
} |
Status Code |
201 |
Response Payload |
Click to view the Response Payload
{
} |
Unsuccessful Responses
Scenario: Trying to create a business object with empty request body.
Header Name:
Authorization: Sessionkey
Code |
ISM_4000 |
Description | Invalid Request Payload |
Message |
{ "Message body cannot be empty." } |
HTTP STATUS CODE |
400 |
Scenario: Trying to create a business object invalid request body.
Header Name:
Authorization: Sessionkey
Code |
ISM_4000 |
Description | Invalid Request Payload |
Message |
[ "Invalid Business Object." ], |
HTTP STATUS CODE |
400 |
Scenario: Trying to create a business object with missing mandatory fields.
Header Name:
Authorization: Sessionkey
Code |
ISM_4000 |
Description | Invalid Request Payload |
Message |
[ "Mandatory field "Category" value must be provided.", "Mandatory field "Description" value must be provided.", "Mandatory field "Status" value must be provided." ] |
HTTP STATUS CODE |
400 |
Scenario: When trying to create an incident or update an incident, the application fails to save and give a proper response from our API.
Header Name:
Authorization: Sessionkey
Code |
ISM_5000 |
Description | Internal server error |
Message |
[ "The server encountered an internal error. Please retry the request." ], |
HTTP STATUS CODE |
500 |