Get Business Object by Select

Fetches business object records and displays only the requested fields. For example, you can define to display only Rec ID and Start Date of the business object records.

Base URL:

https://{tenant url}/api/odata/businessobject/{business object name}?$select={names fields yo be displayed}

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

Here is an example to fetch incidents and display only the fields - RecID and StartDateTime for the records fetched.

URL

https://{tenant url}/api/odata/businessobject/incidents?$select=RecId, StartDateTime

Method

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

Status Code

200

Response Payload

 Click to view the response payload.

{

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

"value": [

{

"RecId": "003B58C0B4554E4BAA30DFD88876582A",

"StartDateTime": "0001-01-01T00:00:00Z"

},

{

"RecId": "019A1ED9C77C4210B7054F47D214C004",

"StartDateTime": "0001-01-01T00:00:00Z"

},

{

"RecId": "030F0DA291EC46C9953817F0E22F188E",

"StartDateTime": "0001-01-01T00:00:00Z"

},

{

"RecId": "05B5CD2DFAE54D86A04C74DBF616C1DE",

"StartDateTime": "0001-01-01T00:00:00Z"

}

Unsuccessful Responses

Scenario: Trying to fetch incident without defining the select value.

https://{tenant url}/api/odata/businessobject/incidents?$select=

Header Name:

Authorization: Sessionkey

Code ISM_5000
Description Invalid Request
Message

[

"The Select value cannot be empty. Provide a valid value and try again"

]

HTTP STATUS CODE

500

Scenario: Trying to fetch incident with invalid select value.

https://{tenant url}/api/odata/businessobject/incidents?$filter=Status eq 'New'

Header Name:

Authorization: Sessionkey

Code ISM_4000
Description Invalid Request
Message

[

"Invalid Filter Value. Provide a valid Filter value and try again"

]

HTTP STATUS CODE

400