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

Get a Business Object by ReclD or Unique Key

Here is an example to get a change, problem, incident, or any other business object by RecID or Unique Key.

URL	https://tatnet.ivanti.com/api/odata/businessobject/change(‘02818A8426C9402E8DFE7C8D3132F783’) https://tatnet.ivanti.com/api/odata/businessobject/problem(‘02818A8426C9402E8DFE7C8D3132F783’) https://tatnet.ivanti.com/api/odata/businessobject/incident(‘05B5CD2DFAE54D86A04C74DBF616C1D’)
Method	GET
Header Name	Authorization : Sessionkey
Status Code	200
Response	{ "@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", "CreatedByRecID": "FB884D18F7B746A0992880F2DFFE749C", "CreatedDateTime": "2011-10-09T01:30:36+05:30", "DirectCost": 0, "Emergency": false, "EstimatedCost": 0, "ExternalCalendarLinkID": "", "ExternalTaskLinkID": "", "FinalState": "False", "Impact_Valid": "1AFFC174C7EA4AB79CCA6B15EB67006D", "Impact": "Medium", "LastModBy": "RMatthews", "LastModDateTime": "2011-11-24T01:30:36+05:30", "Owner_Valid": "8C50BA8C88D04AFE8288F9931DCA7CE8", "Owner": "JSmith", "OwnerTeam_Valid": "2E4BABD54FB9420D94F836F0D9B80C47", "OwnerTeam": "Service Desk", "OwnerType": "Profile.Employee", "ParentLink_Category": "", "ParentLink_RecID": "", "ParentLink": null, "Priority": "3", "Reason_Valid": "", "Reason": "", "RecId": "008E3506AF3F4CC190BC95523645D968", "RequestedBy": "Paul H Chang", "RequestorLink_Category": "Employee", "RequestorLink_RecID": "8A6EADA5906F4F4BBCC8F47CC126F374", "RequestorLink": "8A6EADA5906F4F4BBCC8F47CC126F374", "ScheduledEndDate": "2011-12-04T01:30:36+05:30", "ScheduledStartDate": "2011-11-29T01:30:36+05:30", "Service_Valid": null, "Service": "", "Status_Valid": "F93826F7E4394B1E8C8A6CA2C3F07ED3", "Status": "Pending Approval", "Subject": "Installation of Office 2010 compatibility pack", "TargetBreach": false, "TargetDate": "0001-01-01T00:00:00Z", "TypeOfChange_Valid": "E7663AFB13CC47E6BB13DE2DFC66CD8D", "TypeOfChange": "Significant", "Urgency_Valid": "44021B6CC6E44E598868C4B3306053AE", "Urgency": "Medium", "VoteCount": null, "VoteExpirationDateTime": "0001-01-01T00:00:00Z", "VoteTimeout": "0001-01-01T00:00:00Z", "TempChangeTaskSubject": null, "ChangesTested": false, "DetailScreenName": "", "LinkTargetComputer": false, "MsgPreExistInventoryItem": "", "IsScheduledStartDateFilled": false, "RequestorEmail": "[email protected]", "CABMeetingTime": "0001-01-01T00:00:00Z", "CalculatedRiskQuestions": false, "CatalogName": "", "CMApprovedBy": "RMatthews", "CMApprovedDateTime": "2011-10-24T01:30:36+05:30", "IsCIAdded": "0001-01-01T00:00:00Z", "IsStandardChange": false, "Justification_Valid": "217E0FA5EAF243A1B537252F39595489", "Justification": "Incident / Problem", "NoOfCILinked": null, "NoOfTasks": 0, "NoOfTasksCompleted": 0, "OwnerEmail": "", "ReleaseCIJscriptHolder": "", "RequestorFullName": "Paul H Chang", "RiskSum": 0, "SetChangeWindowJscriptHolder": "", "Sponsor_Valid": "D844686D74224F159EAFA7F11D0792EA", "Sponsor": "Allen W Cope", "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

Invalid URL

Scenario: User wants to get a list of alerts from a tenant.

Valid URL example:

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

Invalid URL examples:

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

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

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

https://tatnet.ivanti.com/api/oodata/ alerts

Header Name:

Authorization: Authentication token

Code	ISM_4004
Description	Requested resource does not exist
Message	[ "Invalid Path" ]
HTTP STATUS CODE	404

Invalid Request Payload

Scenario: To fetch a particular business object instance by its ID, the value of key provided is empty or a white space.

Example:

https://tatnet.ivanti.com/api/odata/businessobject/alerts(‘ ‘)

Header Name:

Authorization: Authentication token

Code	ISM_4000
Description	Invalid Request Payload
Message	[ "Key value cannot be empty" ]
HTTP STATUS CODE	400

Invalid Value

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://tatnet.ivanti.com/api/odata/businessobject/alerts(‘1234‘)

https://tatnet.ivanti.com/api/odata/businessobject/alerts(‘random‘)

Header Name:

Authorization: Authentication token

Code	ISM_4000
Description	Invalid Request Payload
Message	[ "Invalid OData query" ]
HTTP STATUS CODE	400

Was this article useful?

The topic was:

Inaccurate

Incomplete

Not what I expected

Other

Privacy and Legal