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

{

"Category": "Computer",

"CreatedBy":"Admin",

"RequestorLink_RecID":"FB884D18F7B746A0992880F2DFFE749C",

"Description" : "test",

"Owner": "BHeath",

"OwnerTeam":"Accounting",

"Subject":"test",

"OwnerTeam_Valid":"8D796372096546AC9008C0EDAB18EE5F",

"Owner_Valid":"147098AD139247F6B177042064C5E39C",

"Status":"Logged",

"TypeOfChange": "Minor"

}

Status Code

201

Response Payload

{

"@odata.context": "http://{tenant url}/api/odata/change/$metadata#changes/$entity",

"AcceptanceDueDate": "0001-01-01T00:00:00Z",

"AcceptTimeout": "0001-01-01T00:00:00Z",

"BackoutPlanAttached": false,

"BallotCount": null,

"BusinessFunction_Valid": null,

"BusinessFunction": null,

"Category_Valid": "18FCF302685C41A9AB4D4E6C52123A56",

"Category": "Computer",

"ChangeNumber": 0,

"ClosedBy": null,

"ClosedCode_Valid": null,

"ClosedCode": null,

"ClosedDateTime": "0001-01-01T00:00:00Z",

"CompletedBy": null,

"CreatedBy": "Admin",

"CreatedByRecID": "FB884D18F7B746A0992880F2DFFE749C",

"CreatedDateTime": "2018-08-07T06:06:52+05:30",

"DirectCost": 0,

"Emergency": false,

"EstimatedCost": 0,

"ExternalCalendarLinkID": null,

"ExternalTaskLinkID": null,

"FinalState": "False",

"Impact_Valid": null,

"Impact": null,

"LastModBy": "Admin",

"LastModDateTime": "2018-08-07T11:36:52+05:30",

"Owner_Valid": "147098AD139247F6B177042064C5E39C",

"Owner": "BHeath",

"OwnerTeam_Valid": "8D796372096546AC9008C0EDAB18EE5F",

"OwnerTeam": "Accounting",

"OwnerType": null,

"ParentLink_Category": null,

"ParentLink_RecID": null,

"ParentLink": null,

"Priority": null,

"Reason_Valid": null,

"Reason": null,

"RecId": "67D90C9B57334F84A7B0EEEEA3FBC743",

"RequestedBy": "Administrator Admin",

"RequestorLink_Category": "Employee",

"RequestorLink_RecID": "FB884D18F7B746A0992880F2DFFE749C",

"RequestorLink": "FB884D18F7B746A0992880F2DFFE749C",

"ScheduledEndDate": "0001-01-01T00:00:00Z",

"ScheduledStartDate": "0001-01-01T00:00:00Z",

"Service_Valid": null,

"Service": null,

"Status_Valid": "DED387BDB5D843B089246E22563F6446",

"Status": "Logged",

"Subject": "test",

"TargetBreach": false,

"TargetDate": "0001-01-01T00:00:00Z",

"TypeOfChange_Valid": "B3DB5AAC881E4D88A97890232C867B4D",

"TypeOfChange": "Minor",

"Urgency_Valid": null,

"Urgency": null,

"VoteCount": null,

"VoteExpirationDateTime": "0001-01-01T00:00:00Z",

"VoteTimeout": "0001-01-01T00:00:00Z",

"TempChangeTaskSubject": null,

"ChangesTested": false,

"DetailScreenName": null,

"LinkTargetComputer": false,

"MsgPreExistInventoryItem": null,

"IsScheduledStartDateFilled": false,

"RequestorEmail": "[email protected]",

"CABMeetingTime": "0001-01-01T00:00:00Z",

"CalculatedRiskQuestions": false,

"CatalogName": null,

"CMApprovedBy": null,

"CMApprovedDateTime": "0001-01-01T00:00:00Z",

"IsCIAdded": "0001-01-01T00:00:00Z",

"IsStandardChange": false,

"Justification_Valid": null,

"Justification": null,

"NoOfCILinked": 0,

"NoOfTasks": 0,

"NoOfTasksCompleted": 0,

"OwnerEmail": "[email protected]",

"ReleaseCIJscriptHolder": null,

"RequestorFullName": "Administrator Admin",

"RiskSum": 0,

"SetChangeWindowJscriptHolder": null,

"Sponsor_Valid": null,

"Sponsor": null,

"RiskLevel_Valid": null,

"RiskLevel": null,

"RiskCatalogLink_Category": null,

"RiskCatalogLink_RecID": null,

"RiskCatalogLink": null,

"ReleaseLink_Category": null,

"ReleaseLink_RecID": null,

"ReleaseLink": null,

"TriggerChangesToCI": "0001-01-01T00:00:00Z",

"RequesterLocation": "USA",

"RequesterPhone": "7195551254",

"MCVoteExpirationDateTime": "0001-01-01T00:00:00Z",

"ECABVoteExpirationDateTime": "0001-01-01T00:00:00Z",

"CABVoteExpirationDateTime": "0001-01-01T00:00:00Z",

"SubmissionDeadLineDateTime": "0001-01-01T00:00:00Z",

"CABReviewDate": "0001-01-01T00:00:00Z",

"RiskTotalScore": null,

"ReadOnly": false,

"OwnerFullName": "Bo R Heath",

"Cost": 0,

"TotalTimeSpent": 0,

"IsUnRead": false

}

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