Delete Linked Related Business Objects
You can delete related business objects that are linked.
Base URL:
https://{tenant url}/api/odata/businessobject/{business object name}('{business object RecID}')/{business object relationship name}('{RecID of the related business object}')/$Ref
Ensure the business object name is suffixed with an "s".
Here is an example to delete a journal in an incident business object.
URL |
https://{tenant url}/api/odata/businessobject/incidents('87168FCA6F0C46B2B5CDC5226FB7C773')/ IncidentContainsJournal('4F34DB8563DF450CAE5381CDA9805B21')/$Ref |
Method |
Delete |
Header Name | Authorization: JWT Token/Session Key/REST API Key |
Status Code |
204 |
Response Payload |
Click to view response payload
{ "code": "ISM_2000", "description": "Ok", "message": [ "Successfully Deleted the link" ], "help": "" } |
Unsuccessful Responses
Scenario: Trying to delete a link when the url is invalid.
Invalid URL:
https://{tenant url}/api/odata/businessobject/incident('87168FCA6F0C46B2B5CDC5226FB7C773')/IncidentContainsJournal('4F34DB8563DF450CAE5381CDA9805B21')/$Ref
Header Name:
Authorization: Sessionkey
Code | ISM_4004 |
Description | Bad Request |
Message |
[ "No service for type 'Microsoft.OData.Edm.IEdmModel' has been registered." ] |
HTTP STATUS CODE |
404 |
Scenario: Trying to delete 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 |