This API creates a description for an existing Material Transfer Report (MTR) header in Smart Materials.
Required Privilege: API_CREATE_MTRHEADER
Headers
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')/ TransferHeaders({key})/Com.Ingr.Smat.V1.TransferDescription/
Specify values for 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 Transfer header Id.
Element |
Description |
Type |
Required |
Notes |
---|---|---|---|---|
NlsId |
Unique ID of the national language |
Decimal |
Required |
To view available languages, use: GET https://{host}/Smat/V1/Projects(‘:project’) |
ShortDesc |
Language dependent short description for the MTR rule |
String |
Required |
Maximum allowed length is 20. |
Description |
Language dependent description for the MTR rule |
String |
Required |
Maximum allowed length is 60. |
Sample Code
POST https://localhost:53965/SMAT/V1//Projects('AB')/Disciplines('PIPING')/Nls('English')/TransferHeaders
(12345)/Com.Ingr.Smat.V1.TransferDescription
{
"nlsDecsription":{
"NlsId":1,
"ShortDesc":"short description",
"Description":"this is the description of the MTR Header"
}
}
Success Response
Status: 200 OK
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Edm.Int64",
"value":0
}