This API retrieves the Release Notes (RN) of a project from Smart Materials. You can either retrieve a single Release Note using (ReleaseNoteId) or all the Release Notes of a project.
Required Privilege: API_TRAFFIC
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’)/ReleaseNotes({key})
Specify values for the 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 Release Note Id (ReleaseNoteId).
To retrieve all the Release Notes of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/ReleaseNotes
Sample Code
GET http://localhost:26011/SMAT/V1/Projects('RS')/Disciplines('PIPING')/Nls('English')/ReleaseNotes(5020)
Success Response
Status Code: 200 OK
"@odata.context": "http://localhost:26011/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/ReleaseNotes",
"value": [
{
"OrderId": 5580,
"RelnId": 5020,
"ReleaseNoteNumber": "RELN-1127",
"EMLId": 9992,
"SupplierId": 6292,
"MOTId": 5300,
"AssociatedRequisitions": "1127",
"NoOfPackages": 1639,
"TotalGrossWeight": 112,
"RNWeightUnitId": 500140,
"TotalVolume": -1,
"VolumeUnit": "rwetert",
"TotalFrieghtTon": -1,
"ContingencyInd": "N",
"TotalRNTransportCost": 0,
"ProjectCurrencyId": 500391,
"DiffInd": "N",
"MOCInd": "N",
"DeliveryDesignationId": 5081,
"RoutingMethodId": 10000000692,
"IncotermId": 5012,
"DeliveryPlace": "FRANCE",
"ReadyDate": "2020-04-06T00:00:00+05:30",
"CollectionPoint": "DSSSSSSSSSSSSSSSSSSSSSSS1",
"ReleaseToForwarder": "2016-03-14T00:00:00+05:30",
"SellingPrice": 0,
"SellingPriceCurrencyId": null,
"FreeOfChargeInd": "N",
"CalculatedAmount": 0,
"MasterTagAmount": 0,
"Currency": "€",
"PackageInd": "Y",
"OSDTrafficInd": "N",
"OSDSiteInd": "Y"
}
|
Element |
Description |
Type |
|---|---|---|
|
OrderId |
Unique ID of the order number. The retrieved release note belongs to this order number. |
Integer64 |
|
RelnId |
Unique ID of the retrieved release note |
Integer64 |
|
ReleaseNoteNumber |
Name (code) of the release note |
String |
|
EMLId |
ID of the Equipment and Material List (EML) number.
|
Integer64 |
|
SupplierId |
ID of the supplier attached with the release note |
Integer64 |
|
MOTId |
Unique ID of the Method of Transportation (MoT) |
Integer64 |
|
AssociatedRequisitions |
Refer to the requisitions associated with the retrieved release note |
String |
|
NoOfPackages |
Total number of packages associated with the retrieved release note.
|
Integer64 |
|
TotalGrossWeight |
Total gross weight of all the packages defined for the release note.
|
Decimal |
|
RNWeightUnitId |
Weight unit of the total gross weight of the retrieved release note |
Integer64 |
|
TotalVolume |
Sum of the total volume of all the packages.
|
Decimal |
|
VolumeUnit |
Unit of the total volume.
|
String |
|
TotalFreightTon |
Sum of the freight tons of all the packages that are defined for the release note. |
Decimal |
|
ContingencyInd |
Indicates whether atleast one transport cost detail assigned to this release note is related to a transport code marked as contingency or not. Available values are Y and N. |
String |
|
TotalRNTransportCost |
Sum of the transport cost details attached to both the release note as well as its packages.
|
Decimal |
|
ProjectCurrencyId |
ID of the currency of the project. Its value is defined by the project default ZX_CURCY. |
Integer64 |
|
DiffInd |
Indicates whether the transport cost details for a release note and/or its packages are defined in different countries or not. Available values are Y and N. |
String |
|
MOCInd |
Indicates whether the the release note is found on a Means of Conveyance (MOC), to which the transport costs is assigned or not. Available values are Y and N. |
String |
|
DeliveryDesignationId |
ID of the delivery designation of all the item shipments that are part of the release note |
Integer64 |
|
RoutingMethodId |
ID of the routing method of all the item shipments present on the release note |
Integer64 |
|
IncotermId |
ID of the incoterm of all the item shipments present on the release note |
Integer64 |
|
DeliveryPlace |
Delivery place of all the item shipments of the release note |
String |
|
ReadyDate |
Refers to the date and time when the material can be picked up and is given by the supplier |
DateTimeOffset |
|
CollectionPoint |
Precise delivery place of the material as given by the supplier |
String |
|
ReleaseToForwarder |
Refers to the date and time when the transport of the material is released to the freight forwarder |
DateTimeOffset |
|
SellingPrice |
Selling price |
Decimal |
|
SellingPrice CurrencyId |
ID of the currency of the selling price |
Integer64 |
|
FreeOfChargeInd |
Indicates whether the delivery is free of charge or not. Available values are Y and N. |
String |
|
CaculatedAmount |
Amount of the invoice automatically calculated by the system.
|
Integer64 |
|
MasterTagAmount |
If detail tags are created and placed on different release notes, then the costs of their master tag are shown here |
Integer64 |
|
Currency |
Currency of the invoice amount.
|
String |
|
PackageInd |
Indicates whether all the item shipments of the release note with their quantities are placed on the packages or not. Available values are Y and N. |
String |
|
OSDTrafficInd |
Indicates whether the traffic OSD exists for the package or not. Available values are Y and N. |
String |
|
OSDSiteInd |
Indicates whether the site OSD exists for the package or not. Available values are Y and N. |
String |
Refers to the sum of field 'Quantity' in the second block 'Packages' of screen P.70.74
of Classic.
