This API retrieves the requisition details from a project of Smart Materials. You can either retrieve a single requisition details using requisition Id or all the requisitions 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’)/Requisitions({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 requisition Id (RId).
To retrieve all the requisitions of a project, use the following URL:
GET https://{host}/Smat/V1/Projects(‘:project’)/Disciplines(‘:discipline’)/Nls(‘:language’)/Requisitons
Sample Code
GET https://localhost:59387/smat/v1/Projects('RS')/Disciplines('PIPING')/Nls('English')/Requisitions(10000109268)
To view the requisition line items, exapnd LineItems property using Odata Query.
Success Response
Status: 200 OK
{
"@odata.context": "http://localhost:59387/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/Requisitions/$entity",
"RId": 10000109268,
"ProjId": "RS",
"DpId": 5020,
"ReqCode": "KV_REQ_IC",
"Supplement": 0,
"PurchaseInd": "Y",
"OriginId": 500005,
"OriginCode": "HOME",
"MRRevision": "2",
"SRRevision": "2",
"BalanceInd": "N",
"RequisitionType": "Order",
"AgreementType": null,
"PricingType": null,
"ReqStatusCode": "CLOSED",
"ReleaseContext": "All Quantities",
"RelToProcDate": "2019-12-26T11:25:22+05:30",
"RelToProcBy": "KVEMULA",
"BuyCycle": null,
"NotesInd": "N",
"TechEvalRequiredInd": "N",
"ReadyForApprovalInd": "Y",
"ApprovedDate": "2019-12-26T11:25:00+05:30",
"ApprovedBy": "KVEMULA",
"Originator": "KVEMULA",
"TemplateSet": null,
"MatlWorkGroupCode": null,
"RevisionId": null,
"SectionCode": null,
"Category": null,
"AccountCode": null,
"OriginalBudget": 0,
"TotalBudget": 0,
"CurrencyCode": "€",
"BlanketOrder": null,
"MasterAgreement": null,
"InquiryRequisition": null,
"MilestoneSet": null,
"MSLinkInd": "Y",
"MSSuppInd": "N",
"ExpeditingLevel": null,
"InspectionLevel": null,
"CriticalityLevel": null,
"ShortDescription": null,
"Description": null,
"ReqNodePath": "PIPING/MKO",
"MTOType": null,
"MTOJob": null,
"CreatedDate": "2019-12-26T11:01:18+05:30",
"GeneralCIPInd": "N",
"CalcAccountInd": "N",
"CalcBudgetInd": "N",
"GetDesigInd": "N",
"HandleBOMDocInd": "N",
"GetProcureChannelInd": "N",
"CalcROSDateInd": "N",
"CalcWeightInd": "N",
"CurrencyId": 500391
}
Element |
Description |
Type |
---|---|---|
RId |
Unique ID of the retrieved requisition |
Integer |
ProjId |
Unique ID of the project to which the given requisition belongs |
String |
ReqCode |
Name of the requisition |
String |
Supplement |
Supplement number of the engineering requisition. First version of the supplement
number |
Decimal |
OriginId |
Unique ID of the office that is responsible for the given requisition |
Integer |
OriginCode |
Name of the office that is responsible for the given requisition |
String |
BalanceInd |
Indicates whether the given requisition is created through balance MTO job or not. Available values are Y and N. |
String |
ReqStatusCode |
Name of the requisition status defined in R.10.11 Req Status screen. |
String |
BuyCycle |
The name of the requisition buy cycle |
Integer |
NotesInd |
Indicates whether the notes are assigned to the engineering requisition or not. Available values are Y and N. |
String |
TemplateSet |
Name of the email template set as maintained in screen A.10.53. |
String |
MatlWorkGroupCode |
Name of the material/work group as maintained in screen P.10.42 Material/Work Groups. |
String |
AccountCode |
Name of the account code defined in screen A.10.30 Account Codes. |
String |
TotalBudget |
Sum of the line item budget values below this engineering requisition. |
Decimal |
BlanketOrder |
Number of the blanket order maintained in the module P.50.07. Only approved blanket orders are available. |
String |
MasterAgreement |
Name of the master agreement assigned to the requisition.Only approved master agreements are available. |
String |
InquiryRequisition |
Name of the linked inquiry requisition.This inquiry requisition must be approved and
released to procurement. |
String |
MSLinkInd |
Indicates whether the given engineering requisition is linked to a planned requisition or not. Available values are Y and N. |
String |
MSSuppInd |
Indicates whether a milestone supplement exists or not. Available values are Y and N. |
String |
ExpeditingLevel |
Name of the level of expediting as maintained in screen P.10.55 Expediting Levels. |
String |
InspectionLevel |
Name of the level of inspection as maintained in screen P.10.55 Expediting Levels. |
String |
CriticalityLevel |
Name of the level of criticality as maintained in screen P.10.55 Expediting Levels. |
String |
ShortDescription |
Language dependent short description for the given engineering requisition |
String |
Description |
Language dependent description for the given engineering requisition |
String |
ReqNodePath |
Path of the requisition in the requisition nodes tree |
String |
GetProcureChannelInd |
Indicates whether the CIP function 'fast_progress' is executed or not. Available values are Y and N. |
String |
PurchaseInd |
Indicates whether the line items of the requisition can be used for purchase or not. Available values are Y and N. |
String |
RevisionId |
Unique ID of the revision of the materials/work group |
Integer |
DpId |
Unique ID of the discipline to which the given requisition belongs |
Integer |
MTOType |
Unique ID of the Material take Off type |
Integer |
MTOJob |
Unique ID of the MTO Job name within this project |
Integer |
OriginalBudget |
Original budget value |
Decimal |
TechEvalRequiredInd |
Indicates whether this requisition must be committed by a technical engineer |
String |
ReadyForApprovalInd |
Indicates whether this engineering requisition is ready for approval or not. Available values are Y and N. If the value is Y, and the project default ZR_ADV_APP is also set to Y, |
String |
Originator |
User who has created the engineering requisition |
string |
CurrencyId |
Unique ID of the currency used in budget |
Integer |
CurrencyCode |
Name of the currency |
String |
ReleaseContext |
Refers to the release context that is applied on the |
String |
MilestoneSet |
Unique ID of the milestone set as defined in the screen P.10.62 |
Integer |
Category |
Unique ID of the requisition category as maintained in the screen R.1014 |
Integer |
ApprovedBy |
Name of the user who has approved this engineering requisition |
String |
ApprovedDate |
Date on which the engineering requisition is approved |
Date Time Offset |
MRRevision |
Refers to the MR revision value and is controlled by two project defaults.
|
String |
SRRevision |
Refers to the SR revision value and is controlled by two project defaults.
|
String |
GeneralCIPInd |
Indicates whether the function 'general-CIP' is executed or not. Available values are Y and N. |
String |
CalcAccountInd |
Indicates whether the function 'calc_account' is executed or not. Available values are Y and N. |
Strng |
CalcBudgetInd |
Indicates whether the function 'get_budget' is executed or not. Available values are Y and N. |
String |
CalcROSDateInd |
Indicates whether the function 'calc_ros_date' is executed or not. Available values are Y and N. |
String |
CalcWeightInd |
Indicates whether the function 'calc_weight' is executed or not. Available values are Y and N. |
String |
CreatedDate |
Date when the requisition is created |
Date Time Offset |
HandleBOMDocInd |
Indicates whether the CIP m_pck_req_custom.handle_bom_doc is executed or not. Available values are Y and N. |
String |
RequisitionType |
Refers to the requisition type on the basis of order and subcontract. |
String |
AgreementType |
Type of the agreement. Available agreement type depends on |
String |
PricingType |
Name of the pricing type as defined in the screen P.10.66 |
Integer |
RelToProcBy |
User who has released this engineering requisition to the procurement. |
String |
ReIToProcDate |
Date when this engineering requisition is released to the procurement |
Date Time Offset |
SectionCode |
Name of the section as maintained in screen P.10.36 Sections |
String |
GetDesignInd |
Indicates whether the function 'get_design' is executed or not. Available values are Y and N. |
String |