Service Manager

Home

This is the latest version of the help for Ivanti Service Manager 2018. If you cannot find some of the features described in the help, you may be using an older version of the application. To upgrade the application, click here.
To view the help for the latest version of Service Manager, click here

Create a Business Object

Here is an example to create a change, problem, incident, or any other business object.

URL	https://tatnet.ivanti.com/api/odata/businessobject/change https://tatnet.ivanti.com/api/odata/businessobject/problem https://tatnet.ivanti.com/api/odata/businessobject/incident
Method	POST
Header Name	Authorization : Sessionkey
Status Code	201
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" }
	{ "Category": "Access Control Fault", "CreatedBy":"Admin", "Description" : "test", "Impact":"Low", "Impact_Valid":"0ABE7B9E677D4A70BDC3BC5E9B19B258", "IsInFinalState" : false, "LastModBy":"Admin", "Owner": null, "OwnerTeam":"Problem Management", "OwnerTeam_Valid":"2D8B66566B3842EA9D13C40EC10B522A", "Source":"Chat", "Status":"Logged", "Status_Valid":"C3DC3D8F8EEB44F0BF23F3EFA5B1DB3E", "Subject":"test", "TypeOfProblem":"Problem", "TypeOfProblem_Valid":"B14E72C4C16B4CE795461B3487CCA804", "ProblemNumber": 101001 }
	{ "Category" : "Application Security", "ProfileFullName" : "Richard M Wright", "ProfileLink_Category" : "Employee", "ProfileLink_RecID" : "6EFAB27E9F164ECF96364EF18D233D26", "Service" : "Desktop Service", "Status" :"Active", "IncidentNumber" : 10001231, "Subject" : "Cannot authorize expense report from mobile device", "Symptom" : "Cannot authorize expense report from mobile device", "Urgency" : "High", "Impact" : "High", "Owner" :"RThomas", "OwnerTeam": "Service Desk" }
Response Payload	{ "@odata.context": "http://localhost/SaaS/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

Empty Request Body

Scenario: To create a business object instance, an empty request body is provided.

Example:

https://tatnet.ivanti.com/api/odata/businessobject/alerts

Header Name:

Authorization: Authentication token

Code	ISM_4000
Description	Invalid Request Payload
Message	{ "Message body cannot be empty." }
HTTP STATUS CODE	400

Invalid Request Body

Scenario: To create a business object instance, an empty request body is passed.

Example:

https://tatnet.ivanti.com/api/odata/businessobject/alerts

Header Name:

Authorization: Authentication token

HTTP POST	Request body is {random} Request body is {name: test}
Code	ISM_4000
Description	Invalid Request Payload
Message	[ "Invalid Business Object." ],
HTTP STATUS CODE	400

Missing Required Fields

Scenario: To create a business object instance, an invalid request body is passed or the required fields are missing.

Example:

https://tatnet.ivanti.com/api/odata/businessobject/alerts

Header Name:

Authorization: Authentication token

HTTP POST	Request pay load : {"name": "test"}
Code	ISM_4000
Description	Invalid Request Payload
Message	[ "Required field Alert.Category value must be provided.", "Required field Alert.Description value must be provided.", "Required field Alert.Status value must be provided." ],
HTTP STATUS CODE	400

Invalid Response

Scenario: To create an incident or update an incident, the system fails to save and give a proper response from our API.

Header Name:

Authorization: Authentication token

HTTP POST/PUT/PATCH
Code	ISM_5000
Description	Internal server error
Message	[ "The server encountered an internal error. Please retry the request." ],
HTTP STATUS CODE	500

Was this article useful?

The topic was:

Inaccurate

Incomplete

Not what I expected

Other

Privacy and Legal