This API creates a language dependent description of the Forecast header in Smart Materials.
Required Privilege: API_CREATE_FAHEADER
Header
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: POST https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/Forecasts({key})/Com.Ingr.Smat.V1.ForecastDescription
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 Forecast header Id (FahId).
|
Element |
Description |
Type |
Required |
Notes |
|---|---|---|---|---|
|
NlsId |
Unique ID of the national language |
Decimal |
Required |
|
|
ShortDesc |
Short description of the Forecast Run |
String |
Required |
Either ShortDesc or Description is mandatory. |
|
Description |
Description of the Forecast Run |
String |
Required |
Either ShortDesc or Description is mandatory. |
Sample Code
POST https://{host}/Smat/V1/Projects('RS')/Disciplines('PIPING')/NLS('English')/Forecasts(5468)/Com.Ingr.Smat.V1.ForecastDescription
{
"nlsDescription":{
"NlsId":1,
"ShortDesc":"short description",
"Description":"This is a long description"
}}
Success Response
Status: 200 OK
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Edm.Int64",
"value":0
}