Languages - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R2 (2.2)

This API retrieves the languages of a project from Smart Materials. You can either retrieve a single language using language Id or all the languages of a project.

Required Privilege: API_READONLY

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Languages({key})

Specify values for the project, discipline, language, and key parameter in the URL. The project, discipline, and language together, define the project environment and the key parameter defines the language Id (NlsId).

To retrieve all the languages of a project, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Languages

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/Languages(1)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects(’RS’)/Disciplines('PIPING')/Nls(’English’)/Languages",

"value": [

{

"NlsId":1,

"Description":"English",

"UseGenNls":"Y"

}]

}

Element

Description

Type

NlsId

Unique ID of the retrieved national language

Byte

Description

Description of the retrieved national language

String

UseGenNls

Available values are Y and N.

  • If value Y is passed, given language is considered while building commodity code NLS and ident NLS.

String