Sampling - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.2)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.2

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

SourceCorpusPath

Partial path where the input json file is placed.

String

Required

OutputListPath

Partial path where the output json file is generated.

String

Required

AnnotationPath

Partial path of the directory where the annotation is stored.

String

Required

IsAnnotationExist

A flag to check if Sampling should run with or without an annotation file.

Boolean

Required

Sample request

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

{

"SourceCorpusPath": "commoditycode\\Sampling\\",

"OutputListPath": "commoditycode\\Sampling\\",

"AnnotationPath": "commoditycode\\Sampling\\",

"IsAnnotationExist": true

}

  • Provide only the partial path (or latter path) of the complete path. The initial path of the complete path (for example, <Drive_name://<Folder_name>) is already provided to the SRD application using the File(s) Location field in the Options screen.

  • If IsAnnotationExist flag is true, the annotation file is considered for sampling, else, the sampling happens without considering the annotation file.

Response

Element

Description

Type

Notes

SourceCorpusPath

Partial path where the input json file is placed.

String

OutputListPath

Partial path where the output json file is generated.

String

AnnotationPath

Partial path of the directory where the annotation is stored.

String

IsAnnotationExist

A flag to check if Sampling should run with or without an annotation file.

Boolean

Sample Response

{

"@odata.context":

"https://<appserver with domain>/<virtual_directory>/Srd/V2/$metadata#Projects('HCCI')/Disciplines(4999)/Nls(1)/Samplings/$entity",

"SourceCorpusPath": "commoditycode\\Sampling\\",

"OutputListPath": "commoditycode\\Sampling\\",

"AnnotationPath": "commoditycode\\Sampling\\",

"IsAnnotationExist": true

}