Get Related Business Objects

You can get all the related business objects that are linked to a business object.

Base URL:

https://{tenant url}/api/odata/businessobject/{business object name}('{business object unique key}')/{relationship name}

Ensure the business object name is suffixed with an "s".

Here is an example to get related business objects linked to an incident.

URL

https://{tenant url}/api/odata/businessobject/incidents

('0A8C17C5DF534513AACCBB543C60B1D5')/IncidentContainsJournal

Method

GET
Header Name Authorization: JTW Token/Session Key/REST API Key
Status Code

200
Response Payload

{

"@odata.context": "{tenant url}/api/odata/$metadata

#Collection(MetaData.journal)",

"value": [

{

"Category_Valid": "079449CD8C0040E7B580AD0DFFAC76FB",

"Category": "Outgoing Email",

"CreatedBy": "ATaylor",

"CreatedDateTime": "2019-02-01T04:55:28Z",

"JournalType": "Email",

"LastModBy": "ATaylor",

"LastModDateTime": "2019-02-01T04:55:28Z",

"Owner_Valid": null,

"Owner": null,

"OwnerTeam_Valid": null,

"OwnerTeam": null,

"OwnerType": "",

"ParentLink_Category": "Incident",

"ParentLink_RecID": "0A8C17C5DF534513AACCBB543C60B1D5",

"ParentLink": null,

"RecId": "06E745A9F96F412CB92DB567911D8F4F",

"Subject": "Incident# 21206 is assigned to your group",

"TypeAlias": null,

"PublishToWeb": false,

"AttachmentName": null,

"AttachmentExtension": null,

"AttachmentData": "",

"ReadOnly": false,

"IsNewRecord": false,

"IsUnRead": false,

"ParentOwner": "RThomas",

"UnreadTransition": false

}

]

}

Unsuccessful Responses

Scenario: Trying to get related business objects when the url is invalid.

Invalid URL examples:

https://{tenant url}/api/odata/businessobject/incident('0A8C17C5DF534513AACCBB543C60B1D5')/IncidentContainsJournal

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 get related business objects when the RecID of the linked main business object is invalid.

Example:

https://{tenant url}/api/odata/businessobject/incidents('1234')/IncidentContainsJournal

Header Name:

Authorization: Sessionkey

Code ISM_4000
Description Invalid Request
Message

[

"Linked resource does not exist."

]

HTTP STATUS CODE

400