Revision of a Material Issue Report - 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 creates a revision number for an existing Material Issue Report (MIR).

You can revise a MIR of type MIR by BOM Commodity (B) only.

Required Privilege: API_MIR

Headers

Header Name

Description

Required

Values

Authorization

Access token

Required

Bearer <access_token>

Content-Type

Request type format

Required

application/JSON

Body

URL Format: POST https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/IssueReports({key})/Revision

Specify the values for the project, discipline, language, and the key parameter in the URL. The project, discipline, and language together, defines the project environment. The key parameter refers to the Material Issue Report ID (MirId).

Sample Code

POST https://{host}/Smat/V1/Projects Projects('RS')/Disciplines('PIPING')/Nls('English')/IssueReports(100000054471)/Revision

Success Response
Status: 200 OK

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

    "MirId": 10000054472,

    "ProjId": "RS",

    "DpId": 5020,

    "MirNumber": "US0037",

    "RevisionId": 5,

    "MirCreateDate": "2020-11-08T21:04:08+05:30",

    "PostedDate": null,

    "IssueDate": "2012-10-08T00:00:00+05:30",

    "IssueBy": null,

    "CompanyId": 5909,

    "OverIssueWhId": 8401,

    "LocId": 6842,

    "MirType": "B",

    "IssueType": "REGULAR",

    "DirectIssueType": null,

    "CommodityId": null,

    "Ident": null,

    "BnlId": null,

    "TagNumber": null,

    "ScrapWhId": null,

    "WorkOrder": null

}

Element

Description

Type

MirId

Unique ID of the given MIR

Integer64

ProjId

Unique ID of the Project. Given MIR belongs to this project.

String

DpId

Unique ID of the Discipline. Given MIR belongs to this discipline.

Integer64

MirNumber

Name (code) of the MIR.

SHARED Tip If the MirNumber is not given by the user, system provide a number based on the MIR number rule.

String

RevisonId

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

Integer16

MirCreateDate

Date and time of the MIR creation

Date Time Offset

PostedDate

Date and time when the MIR get posted

Date Time Offset

IssueDate

Date and time of the material issue

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

Type of the MIR. MIR by BOM Commodity Type is only supported here.

String

IssueType

Issue type of a MIR.

Allowed issue type options depends on the type of MIR given.

  • If given MIR type is MIR by BOM Commodity (B), then allowed option is:

    • REGULAR.

String

DirectIssueType

Refers to the issue type, when the MIR type is MIR by Direct Issue (D)

String

CommodityId

Unique ID of the commodity

Integer64

Ident

Ident

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