This API retrieves the National Language Support (Nls) of a project from Smart Materials. You can either retrieve a single Nls using Nls description or all the Nls of a project.
No privilege is required to access this API.
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(':key')
Specify values for the project, discipline, and key parameter in the URL. The project and discipline together, define the project environment and the key parameter defines the Nls description.
To retrieve all the Nls of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls",
"value": [
{
"NlsId":"1",
"Description":"English"
}]
}
Element |
Description |
Type |
---|---|---|
NlsId |
Unique ID of the National Language Support |
Byte |
Description |
Description of the NLS |
String |