Read a Material Issue Report (MIR) - Intergraph Smart Materials - Version 2017 R2 (2.2) - Help - Hexagon

Intergraph Smart Materials Web API Help 2017 R2 (2.2)

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

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’)/IssueReports({key})

Specify the 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 Mir 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’)/IssueReports

Sample Code

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

Success Response

Status: 200 OK

Content:

{

    "@odata.context": "http://localhost:53427/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/IssueReports/$entity",

    "MirId": 5046,

    "ProjId": "RS",

    "DpId": 5020,

    "MirNumber": "RW000002",

    "RevisionId": 0,

    "MirCreateDate": "2006-05-17T00:00:00+05:30",

    "PostedDate": "2006-05-17T00:00:00+05:30",

    "IssueDate": "2006-05-17T00:00:00+05:30",

    "IssueBy": null,

    "CompanyId": 5265,

    "OverIssueWhId": 5081,

    "LocId": 5081,

    "MirType": "B",

    "IssueType": "REGULAR",

    "DirectIssueType": null,

    "CommodityId": null,

    "Ident": null,

    "BnlId": null,

    "TagNumber": null,

    "ScrapWhId": null,

    "WorkOrder": null,

"ShortDesc": "testshort",

"Description": "testlong"

}

Element

Description

Type

MirId

Unique ID of the retrieved Material Issue Report

Integer64

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.

Integer64

MirNumber

Name of the MIR

String

RevisionId

Unique revision ID of the MIR. Default value is 0.

Integer16

MirCreateDate

Date when the MIR was created

Date Time Offset

PostedDate

Date when the MIR was posted in the inventory

Date Time Offset

IssueDate

Date when the material was issued

Date

Time Offset

IssueBy

Name of the user who has issued the MIR

String

CompanyId

Unique ID of the company

Integer64

OverIssueWhId

Unique ID of the warehouse used for overissue

Integer64

LocId

Unique ID of the location

Integer64

MirType

Types of the MIR. Available values are:

  • MIR by Direct Issue (D)

  • MIR by BOM Commodity (B).

String

IssueType

Issue type for this MIR.

  • If MIR type is B, available value for issue type is:

    • REGULAR.

  • If MIR Type is D, available values for issue type are:

    • REGULAR

    • OTHER.

String

DirectIssueType

Refers to the issue type, when the MIR type is D.

String

CommodityId

Unique ID of the commodity

Integer64

Ident

Ident number

Integer64

BnlId

Unique ID of the bin location

Integer64

TagNumber

Tag number

String

ScrapWhId

Unique ID of the warehouse used for scrap

Integer64

WorkOrder

Work Order / Agreement

String

ShortDesc

Short description of the MIR header given by the user

String

Description

Long description of the MIR header given by the user

String