GetBusinessObjectMetaData

Role: Administrator.

Minimum Version: IvantiNeurons for ITSM 2025.3.

Fetches details such as the list of fields, relationships, fields of related business objects, saved search names, template names and quick action names for a business object.

Pass the Body Key

Pass the body key as:

{

"BusinessObject" : "frs_knowledge#"

}

To get information about a particular child add its name after "#". For example:

{

"BusinessObject" : "frs_knowledge#Docuemnt"

}

Response

The response returned after executing the GetBusinessObjectMetaData API is JSON based.

Base URL:

https://{tenant url}/api/rest/GetBusinessObjectMetadata

Here is an example to fetch the GetBusinessObjectMetadata for incidents.

URL

https://{tenant url}/api/rest/GetBusinessObjectMetadata

Method

GET
Header Name Authorization: Session Key

Status Code

200

Response Payload

{

"BusinessObject": {

"TableName": "FRS_Knowledge",

"Fields": [

{

"FieldName": "FRS_KnowledgeType",

"DisplayName": "FRS_KnowledgeType",

"DataType": "UnicodeText",

"Length": 300,

"HideFromUI": false,

"System": false,

"IsValidated": false,

"IsLinked": false

},

{

"FieldName": "RecId",

"DisplayName": "RecId",

"DataType": "FixedText",

"Length": 32,

"HideFromUI": true,

"System": false,

"IsValidated": false,

"IsLinked": false

},

{

"FieldName": "LastModDateTime",

"DisplayName": "Modified On",

"DataType": "DateTime",

"Length": 0,

"HideFromUI": false,

"System": false,

"IsValidated": false,

"IsLinked": false

},

{

"FieldName": "LastModBy",

"DisplayName": "Modified By",

"DataType": "UnicodeText",

"Length": 200,

"HideFromUI": false,

"System": false,

"IsValidated": false,

"IsLinked": false

},

{

"FieldName": "CreatedDateTime",

"DisplayName": "Created On",

"DataType": "DateTime",

"Length": 0,

"HideFromUI": false,

"System": false,

"IsValidated": false,

"IsLinked": false

},

{

"FieldName": "CreatedBy",

"DisplayName": "Created By",

"DataType": "UnicodeText",

"Length": 200,

"HideFromUI": false,

"System": false,

"IsValidated": false,

"IsLinked": false

},

{

"FieldName": "OwnerType",

"DisplayName": "OwnerType",

"DataType": "Text",

"Length": 30,

"HideFromUI": false,

"System": false,

"IsValidated": false,

"IsLinked": false

},

],

"LinkedObjects": []

}

}