This API retrieves the inventory transfers of a project from Smart Materials. You can either retrieve a single inventory transfer using inventory transfer Id or all the inventory transfers 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’)/InvTransfers({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 transfer Id (ItrId).
To retrieve all the inventory transfers of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/InvTransfers
Sample Code
GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/InvTransfers(5061)
Success Response
Status: 200 OK
Content:
{
"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/InvTransfers",
"value":[
{
"ItrId":5061,
"ProjId":"RS",
"MtrId":5021,
"IviId":5161,
"WhId":null,
"LocId":null,
"SmstId":null,
"DpId":5020,
"ItrQty":12.234,
"ItrComment":null,
"IvprId":null,
"TargetIviId":5161,
"BnlId":null,
"LisId":null,
"ApoliId":null
}]
}
|
Element |
Description |
Type |
|---|---|---|
|
ItrId |
Unique ID of the inventory transfer |
Integer |
|
ProjId |
Unique ID of the Project. Retrieved inventory transfer belongs to this Project. |
String |
|
MtrId |
Unique ID of the Material Transfer Report |
Integer |
|
IviId |
Source ID of the inventory items |
Integer |
|
WhId |
Unique ID of the warehouse |
Integer |
|
LocId |
Unique ID of the location |
Integer |
|
SmstId |
Unique ID of the site material status |
Integer |
|
DpId |
Unique ID of the Discipline. Retrieved inventory transfers belong to this Discipline. |
Integer |
|
ItrQty |
Quantity of the inventory transfer |
Decimal |
|
ItrComment |
Comment given by the user during inventory transfer creation |
String |
|
IvprId |
Unique ID of the inventory position reservations |
Integer |
|
TargetIviId |
Unique ID of the target inventory item |
Integer |
|
BnIId |
Unique ID of the bin location |
Integer |
|
IisId |
Unique ID of the list |
Integer |
|
ApoliId |
Integer |