Material Receiving Reports (MaterialRecvRpts) - Intergraph Smart Materials - Version 2017 R1 (2.1) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R1 (2.1)

Language
English
Product
Intergraph Smart Materials
Subproduct
Web API
Search by Category
Help
Version Smart Materials Web API
2017 R1 (2.1)

This API retrieves the Material Receiving Reports (MRR) of a project from Smart Materials. You can either retrieve a single report using MRR Id or all the Material Receiving Reports 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')/MaterialRecvRpts({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 Receiving Report Id (MrrId).

To retrieve all the Material Receiving Reports of a project, use the following URL:

GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/MaterialRecvRpts

Sample Code

GET https://{host}/Smat/V1/Projects(‘RS’)/Disciplines(‘PIPING’)/Nls(‘English’)/MaterialRecvRpts(5141)

Success Response

Status: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/MaterialRecvRpts",

"value":[

{

"MrrId":5141,

"ProjId":"RS",

"MrrNumber":"PIPING0001",

"RevisionId":0,

"DpId":5020,

"MrrCreateDate":"2009-12-08T00:00:00+05:30",

"RecvType":"O",

"WhId":6661,

"LocId":5920,

"SmstId":5581,

"SgId":null,

"PohId":null,

"PostedDate":"2009-12-08T12:48:19+05:30",

"MatlRecvDate":"2009-12-08T00:00:00+05:30",

"BnlId":null

}]

}

Element

Description

Type

MrrId

Unique ID of the Material Receiving Report

Integer

ProjId

Unique ID of the Project. Retrieved MRR belongs to this Project.

String

MrrNumber

Name of the MRR

String

RevisionId

Unique ID of the current MRR revision. Default value is 0.

Integer

DpId

Unique ID of the Discipline. Retrieved MRR belongs to this Discipline.

Integer

MrrCreateDate

Date and time when the MRR is created

Date Time Offset

RecvType

Type of receiving

String

WhId

Unique ID of the warehouse

Integer

LocId

Unique ID of the location

Integer

SmstId

Unique ID of the site material status

Integer

SgId

Unique ID of the shipment group

Integer

PohId

Unique ID of the purchase order header

Integer

PostedDate

Date and time when the MRR is posted to the inventory

Date Time Offset

MatlRecvDate

Date and time when the material is received

Date Time Offset

BnlId

Unique ID of the bin location

Integer