This API creates as well as update the description for an existing Material Issue Report (MIR) header in Smart Materials.
Required Privilege: API_CREATE_MIRHEADER
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')/IssueReports({key})/Com.Ingr.Smat.V1.IssuingDescription/
Specify the values for project, discipline, language, and the key parameter in the URL. The project, discipline, and language together, define the project environment. The key parameter defines the MIR ID(MirId) whose description gets added or updated.
|
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 MIR rule |
String |
Required |
Maximum allowed length is 20. |
|
Description |
Language dependent description for the MIR rule |
String |
Required |
Maximum allowed length is 60. |
Sample Code
POST https://{host}/Smat/V1/Projects('AB')/Disciplines('PIPING')/Nls('English')/IssueReports (7896)/Com.Ingr.Smat.V1.IssuingDescription/
{
"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
}