Creating Group Business Objects via REST API

1 min

You can create records for group business objects (for example, Journal#Notes) using the REST OData API. Group names containing a hash (#) must be converted to a URL‑safe format before use. The following rules apply:

If the group name contains a hash symbol (#), replace it with a double underscore (__).

Example:

Original name: Journal#Notes

API‑formatted name: Journal__Notes

All business object names used in the URL must be pluralized by appending an “s”.

Example:

Incident → Incidents

Change → Changes

Journal#Notes → Journal__Notess

The final URL/endpoint format is: https:///api/odata/businessobject/__s

REST Query format: GET https:///api/odata/businessobject/Journal__Notess

Base URL:

https:///api/odata/businessobject/__s

Here is an example to get Group Business Objects.

URL	https:///api/odata/businessobject/__s
Method	GET
Header Name	Authorization: JWT Token/Session Key/REST API Key
Status Code	200
Response Payload	{ "@odata.context": "https:///api/odata/$metadata#__s", "@odata.count": 337, "value": [ { "DisplayText": "", "NotesBody": "", "Source_Valid": "id_001", "Source": "Other", "TimeSpent": 0, "Category_Valid": "id_002", "Category": "Memo", "CreatedBy": "user_001", "CreatedDateTime": "2020-01-01T00:00:00Z", "JournalType": "Notes", "LastModBy": "user_001", "LastModDateTime": "2020-01-01T00:10:00Z", "Owner_Valid": "", "Owner": "", "OwnerTeam_Valid": null, "OwnerTeam": "", "OwnerType": "", "ParentLink_Category": "ServiceReq", "ParentLink_RecID": "id_003", "ParentLink": null, "RecId": "rec_001", "Subject": "Sample Subject", "TypeAlias": null, "PublishToWeb": true, "AttachmentName": null, "AttachmentExtension": null, "AttachmentData": "", "ReadOnly": false, "IsNewRecord": false, "IsUnRead": false, "ParentOwner": null, "UnreadTransition": false, "ExternalCommentID": null }, { "DisplayText": "Sample line 1 Sample line 2", "NotesBody": "Sample note", "Source_Valid": "", "Source": "", "TimeSpent": 0, "Category_Valid": "id_002", "Category": "Memo", "CreatedBy": "user_002", "CreatedDateTime": "2020-01-02T00:00:00Z", "JournalType": "Notes", "LastModBy": "user_003", "LastModDateTime": "2020-01-02T00:00:00Z", "Owner_Valid": "", "Owner": "", "OwnerTeam_Valid": "", "OwnerTeam": "", "OwnerType": "", "ParentLink_Category": "Incident", "ParentLink_RecID": "id_004", "ParentLink": null, "RecId": "rec_002", "Subject": "Sample Subject", "TypeAlias": null, "PublishToWeb": false, "AttachmentName": null, "AttachmentExtension": null, "AttachmentData": "", "ReadOnly": false, "IsNewRecord": false, "IsUnRead": false, "ParentOwner": null, "UnreadTransition": false, "ExternalCommentID": null }, { "DisplayText": "Sample line A Sample line B", "NotesBody": "Sample note", "Source_Valid": "", "Source": "", "TimeSpent": 0, "Category_Valid": "id_002", "Category": "Memo", "CreatedBy": "user_002", "CreatedDateTime": "2020-01-03T17:59:50Z", "JournalType": "Notes", "LastModBy": "user_002", "LastModDateTime": "2020-01-03T17:59:51Z", "Owner_Valid": "", "Owner": "", "OwnerTeam_Valid": "", "OwnerTeam": "", "OwnerType": "", "ParentLink_Category": "Incident", "ParentLink_RecID": "id_005", "ParentLink": null, "RecId": "rec_003", "Subject": "Sample Subject", "TypeAlias": null, "PublishToWeb": false, "AttachmentName": null, "AttachmentExtension": null, "AttachmentData": "", "ReadOnly": false, "IsNewRecord": false, "IsUnRead": false, "ParentOwner": null, "UnreadTransition": false, "ExternalCommentID": null } ] }

Creating Group Business Objects via REST API

Get Group Business Objects - Example