Training - Intergraph Smart Reference Data - Customization & Programming - Hexagon

SRD REST API

ft:locale
en-US
Product
Intergraph Smart Reference Data
Search by Category
Customization & Programming
Smart Materials/Smart Reference Data Version
10.6

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/json

POST body

Element

Description

Type

Required

Notes

ModelOutputFilePath

Path where the trained model will be saved

String

Required

IsCorpusGenerationNeeded

Defines if corpus generation is required for training

Boolean

Required

RegionCode

Region code for system classification

String

Required

MaterialRegionCode

Region code for material classification

String

Required

IsSamplingRequired

Indicates if data sampling is necessary before training

Boolean

Required

Sample request

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityCodeTraining

{

"ModelOutputFilePath": "Training\\Model",

"IsCorpusGenerationNeeded": true,

"RegionCode": "P_SYSTEM",

"MaterialRegionCode": "P_MAT_SYSTEM",

"IsSamplingRequired": false

}

Response

Element

Description

Type

Notes

ModelOutputFilePath

Path where the model has been saved

String

RegionCode

Region code used for system classification

String

MaterialRegionCode

Region code used for material classification

String

IsCorpusGenerationNeeded

Indicates if corpus generation is completed

Boolean

IsSamplingRequired

Indicates if sampling is applied

Boolean

AICCConfigId

Configuration ID associated with the training

Integer

Sample Response

{

"@odata.context": "https://in-srddbvm1.ingrnet.com/SmartReferenceData/SRDAPI/Srd/V2/$metadata#Projects('SDB')/Disciplines(5020)/Nls(1)/CommodityCodeTraining/$entity",

"ModelOutputFilePath": "Training\\Model",

"RegionCode": "P_SYSTEM",

"MaterialRegionCode": "P_MAT_SYSTEM",

"IsCorpusGenerationNeeded": true,

"IsSamplingRequired": false,

"AICCConfigId": 5000

}