Service Manager
Link Business Objects
You can link different business objects based on relationships. For example, you can link a journal to an incident.
Base URL:
https://{tenant url}/api/odata/businessobject/{business object type}('{business object RecID}')/{business object relationship name}('{RecID of the related business object}')/$Ref
Link Business Objects - Example
Here is an example to link a journal to an incident.
| URL |
https://{tenant url}/api/odata/businessobject/incidents ('87168FCA6F0C46B2B5CDC5226FB7C773')/IncidentContainsJournal ('4F34DB8563DF450CAE5381CDA9805B21')/$Ref |
|
Method |
PATCH |
| Header Name | Authorization : Sessionkey |
| Status Code |
200 |
| Response Payload |
Click to view response payload
{ "code": "ISM_2000", "description": "Ok", "message": [ "Successfully Created the link" ], "help": "" } |
Unsuccessful Responses
Invalid URL
Scenario: Trying to create a link when the url is invalid.
Invalid URL examples:
https://{tenant url}/api/odata/businessobject/incident('87168FCA6F0C46B2B5CDC5226FB7C773')/IncidentContainsJournal('4F34DB8563DF450CAE5381CDA9805B21')/$Ref
Header Name:
Authorization: Sessionkey
| Code | ISM_4004 |
| Description | Not Found |
| Message |
[ "No service for the resource is registered." ] |
|
HTTP STATUS CODE |
404 |
Invalid RecID
Scenario: Trying to create a link when the RecID is invalid.
Example:
https://{tenant url}/api/odata/businessobject/incidentS('87168FCA6F0C46B2B5CDC5226FB7C773')/IncidentContainsJournal('1234')/$Ref
Header Name:
Authorization: Sessionkey
| Code | ISM_4000 |
| Description | Invalid Request |
| Message |
[ "Record '1234' cannot be found in the related business object 'Journal#". ] |
|
HTTP STATUS CODE |
400 |
Was this article useful?
Copyright © 2019, Ivanti. All rights reserved.