This API retrieves the inventory issues of a project from Smart Materials. You can either retrieve a single inventory issue using inventory issue Id or all the inventory issues 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')/InvIssues({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 inventory issue Id (IisId).
To retrieve all the inventory issues of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/InvIssues
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/InvIssues(5295)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/InvIssues",
"value":[
{
"IisId":5295,
"ProjId":"RS",
"IviId":5222,
"MirId":5106,
"DpId":5020,
"LpId":6264017,
"IssueQty":20,
"IssueDate":"2009-12-10T00:00:00+05:30",
"ItemShipId":null,
"OverissueQty":10,
"RevOverissueQty":10,
"ResvQty":0,
"IvprId":null
}]
}
Element |
Description |
Type |
---|---|---|
IisId |
Unique ID of the retrieved inventory issue |
Integer |
ProjId |
Unique ID of the Project. Retrieved inventory issue belongs to this Project. |
String |
IviId |
Unique ID of the inventory items |
Integer |
MirId |
Unique ID of the Material Issue Report (MIR) |
Integer |
DpId |
Unique ID of the Discipline. Retrieved inventory issues belong to this Discipline. |
Integer |
LpId |
Unique ID of the list positions |
Integer |
IssueQty |
Issued quantity |
Decimal |
IssueDate |
Date and time of the material issue |
Date Time Offset |
ItemShipId |
Unique ID of the item shipments |
Integer |
OverIssueQty |
Received quantity by an overissue |
Decimal |
RevOverissueQty |
Revised quantity by an overissue |
Decimal |
ResvQty |
Reserved quantity by a Forecast |
Decimal |
IvprId |
Unique ID of the inventory position reservations |
Integer |