api/BillOfMaterial/Query (POST)

Queries existing Bill of Material Components using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Bill of Material Components.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing Bill of Material query data.

Query Single Bill Of Material Component Using Key Fields Example:
{
  "ASSEMBLY_ID": "PUMP002",
  "COMPONENT_ID": "MOTOR003",
  "DWG_ITEM_CODE": "0001"
}
Returns 1 Bill of Material Component if successful.
This is like 'Find' in Expandable.

Query Multiple Bill of Material Components Using Other Fields Example:
{
  "ASSEMBLY_ID": "PUMP002",
  "COMPONENT_TYPE": "MC"
}
Returns 1 or more Bill of Material Components if successful.
This is like 'QBE' in Expandable.

Query Multiple Bill of Material Components Using QBE Conditional Notation Example:
{
  "ASSEMBLY_ID": "PUMP002",
  "COMPONENT_ID": "IN 'MOTOR003','MOUNT007'"
}
Returns 1 or more Bill of Material Components if successful.
This is like 'QBE' in Expandable.

Accepted Bill of Material Fields:
ASSEMBLY_ID, BILLS_TYPE, COMPONENT_ID, COMPONENT_TYPE, 
CREATED_BY, DATE_CREATED, DATE_LAST_UPDT, DATE_LOW_LEVEL, 
DATE_MODIFIED, DWG_ITEM_CODE, END_DATE, END_SN, 
KIT_STORES, LOW_LEVEL_CODE, LT_OFFSET, MODIFIED_BY, 
OPER_CODE, OPERATOR_ID, PDFBM_USER_1, PDFBM_USER_2, 
PDFBM_USER_3, PDFBM_USER_4, PDFBM_USER_5, PDFBM_USER_6, 
PDFBM_USER_7, PDFBM_USER_8, REMARK, REQUIRED_QTY, 
SCRAP_FACTOR, START_DATE, START_SN, TIME_LAST_UPDT

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON array with found Bill of Material Components.

Error:
400/Request JSON is invalid.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned Bill of Material Fields:
ASSEMBLY_ID, BILLS_TYPE, COMPONENT_ID, COMPONENT_TYPE, CREATED_BY, DATE_CREATED, DATE_LAST_UPDT, DATE_LOW_LEVEL, DATE_MODIFIED, DWG_ITEM_CODE, END_DATE, END_SN, KIT_STORES, LOW_LEVEL_CODE, LT_OFFSET, MODIFIED_BY, NOTES, OPER_CODE, OPERATOR_ID, PDFBM_USER_1, PDFBM_USER_2, PDFBM_USER_3, PDFBM_USER_4, PDFBM_USER_5, PDFBM_USER_6, PDFBM_USER_7, PDFBM_USER_8, REMARK, REQUIRED_QTY, SCRAP_FACTOR, START_DATE, START_SN, TIME_LAST_UPDT