This API retrieves the Material Issue Reports (MIR) of a project from Smart Materials. You can either retrieve a single MIR using MIR Id or all the MIRs 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’)/MaterialIssueRpts({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 Material Issue Report Id (MirId).
To retrieve all the MIRs of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/MaterialIssueRpts
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/MaterialIssueRpts(5046)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/MaterialIssueRpts",
"value":[
{
"MirId":5046,
"ProjId":"RS",
"DpId":5020,
"MirNumber":"RW000002",
"RevisionId":0,
"MirCreateDate":"2006-05-17T00:00:00+05:30",
"FahId":null,
"PostedDate":"2006-05-17T00:00:00+05:30",
"IssueDate":"2006-05-17T00:00:00+05:30",
"IssueBy":null,
"CompanyId":5265,
"WhId":5081,
"LocId":5081,
"MirType":"B",
"IssueType":"R",
"DirectIssueType":null,
"CommodityId":null,
"Ident":null,
"BnlId":null,
"TagNumber":null
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
MirId |
Unique ID of the Material Issue Report |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved MIR belongs to this Project. |
String |
|
DpId |
Unique ID of the Discipline. Retrieved MIR belongs to this Discipline. |
Integer |
|
MirNumber |
Name of the MIR |
String |
|
RevisionId |
Unique revision ID of the MIR. Default value is 0. |
Integer |
|
MirCreateDate |
Date when the MIR is created |
Date Time Offset |
|
FahId |
Unique ID of the Forecast header |
Integer |
|
PostedDate |
Date when the MIR is posted in the inventory |
Date Time Offset |
|
IssueDate |
Date when the material is issued |
Date Time Offset |
|
IssueBy |
Name of the user who has issued the MIR |
String |
|
CompanyId |
Unique ID of the company |
Integer |
|
WhId |
Unique ID of the warehouse |
Integer |
|
LocId |
Unique ID of the location |
Integer |
|
MirType |
Type of MIR. Available options are:
|
String |
|
IssueType |
Type of material issue. Available options are:
|
String |
|
DirectIssueType |
Type of direct issue. Available options are:
|
String |
|
CommodityId |
Unique ID of the commodity |
Integer |
|
Ident |
Ident number of the material |
Integer |
|
BnlId |
Unique ID of the bin location |
Integer |
|
TagNumber |
Tag number of the material |
String |