api/Part/Query (POST)
Queries existing Parts 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 Parts.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Part query data.
Query Single Part Using Key Fields Example:
{
"PART_ID": "MOTOR003"
}
Returns 1 Part if successful.
This is like 'Find' in Expandable.
Query Multiple Parts Using Other Fields Example:
{
"PART_TYPE": "B",
"PREF_VENDOR": "XYZCORP"
}
Returns 1 or more Parts if successful.
This is like 'QBE' in Expandable.
Query Multiple Parts Using QBE Conditional Notation Example:
{
"SEARCH_NAME": "MOTOR%",
"SHIP_TYPE": "IN 'S','O'"
}
Returns 1 or more Parts if successful.
This is like 'QBE' in Expandable.
Accepted Part Fields:
ABC_CODE, AL_PART_DESC, AUTO_PO_CREATE, BASE_CURR,
BC_RATE, BC_STD_COST, BUY_CONV, BUY_DEC,
BUY_UM, BUYER_ID, CATALOG_DESC, CATALOG_ID,
CATCH_WEIGHT, CATG_CODE, COMM_CODE, COMMENT_ID,
CREATED_BY, CUM_LT, DATE_ACTIVE, DATE_CREATED,
DATE_INACTIVE, DATE_LAST_UPDT, DATE_MODIFIED, DATE_OBSOLETE,
DAYS_SUPPLY, DEF_STORES_CODE, DWG_REV, DWG_SIZE,
ECN, ECN_EFF_DATE, FORECAST_QTY, FRT_CLASS,
ICFPM_USER_1, ICFPM_USER_2, ICFPM_USER_3, ICFPM_USER_4,
ICFPM_USER_5, ICFPM_USER_6, ICFPM_USER_7, ICFPM_USER_8,
ICFPM_USER_9, ICFPM_USER_10, ICFPM_USER_11, ICFPM_USER_12,
ICFPM_USER_13, ICFPM_USER_14, ICFPM_USER_15, ICFPM_USER_16,
ICFPM_USER_17, ICFPM_USER_18, ICFPM_USER_19, ICFPM_USER_20,
ICFPM_USER_21, ICFPM_USER_22, ICFPM_USER_23, ICFPM_USER_24,
ICFPM_USER_25, ICFPM_USER_26, ICFPM_USER_27, ICFPM_USER_28,
ICFPM_USER_29, ICFPM_USER_30, ICFPM_USER_31, ICFPM_USER_32,
ITF_CODE, KIT_LT, LOT_CONTROL, MAX_ORDER_QTY,
MFG_LT, MIN_SALES_QTY, MODIFIED_BY, MPS_CODE,
MRP_FLAG, OPERATOR_ID, ORDER_QTY, ORIG_COUNTRY,
ORIG_REL_DATE, PACK_SIZE, PART_CLASS, PART_DESC,
PART_HOLD_CODE, PART_ID, PART_STATUS, PART_TYPE,
PART_UM, PENDING_ECN, PLAN_HORIZON, PLAN_LEAD_TIME,
PLANNER_ID, PREF_VENDOR, PRICE_CONV, PRICE_UM,
PRODUCT_LINE, QC_FLAG, QTY_PER_CARTON, RECEIVING_LT,
ROHS_COMP_COMM, ROHS_COMP_DATE, ROHS_COMP_ST, ROHS_DOC_COMM,
ROHS_DOC_DATE, ROHS_DOC_ST, ROHS_PROC_COMM, ROHS_PROC_DATE,
ROHS_PROC_ST, SALE_CONV, SALE_DEC, SALE_UM,
SALES_MARKET, SEARCH_NAME, SHELF_LIFE, SHIP_LT,
SHIP_TYPE, SLX_PART, SN_REQD, SN_REQD_INV,
SO_ORDER_QTY, STD_1_HRS, STD_2_HRS, STD_3_HRS,
STD_LAB_CST_ADD, STD_LAB_CST_CUM, STD_LAB_HRS_ADD, STD_LAB_HRS_CUM,
STD_MTL_CST_ADD, STD_MTL_CST_CUM, STD_OH_PCT_BUY, STD_OH_PCT_OUT,
STD_OHD_CST_ADD, STD_OHD_CST_CUM, STD_OTH_CST_ADD, STD_OTH_CST_CUM,
STD_OUT_CST_ADD, STD_OUT_CST_CUM, STD_UNIT_COST, STD_WORK_1,
STD_WORK_2, STD_WORK_3, STOCK_DEC, SUBST_PART,
TAXABLE, TIME_LAST_UPDT, UPC_CODE, VAT_CODE,
VENDR_LEAD_TIME, VOLUME, WARRANTY_DAYS, WEEE_RECY_COMM,
WEEE_RECY_DATE, WEEE_RECY_ST, WEIGHT, YIELD_FACTOR |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON array with found Parts.
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 Part Fields:
ATTACHMENTS, ABC_CODE, AL_PART_DESC, AUTO_PO_CREATE, BASE_CURR, BC_RATE, BC_STD_COST, BUY_CONV, BUY_DEC, BUY_UM, BUYER_ID, CATALOG_DESC, CATALOG_ID, CATCH_WEIGHT, CATG_CODE, COMM_CODE, COMMENT_ID, CREATED_BY, CUM_LT, DATE_ACTIVE, DATE_CREATED, DATE_INACTIVE, DATE_LAST_UPDT, DATE_MODIFIED, DATE_OBSOLETE, DAYS_SUPPLY, DEF_STORES_CODE, DWG_REV, DWG_SIZE, ECN, ECN_EFF_DATE, FORECAST_QTY, FRT_CLASS, ICFPM_USER_1, ICFPM_USER_2, ICFPM_USER_3, ICFPM_USER_4, ICFPM_USER_5, ICFPM_USER_6, ICFPM_USER_7, ICFPM_USER_8, ICFPM_USER_9, ICFPM_USER_10, ICFPM_USER_11, ICFPM_USER_12, ICFPM_USER_13, ICFPM_USER_14, ICFPM_USER_15, ICFPM_USER_16, ICFPM_USER_17, ICFPM_USER_18, ICFPM_USER_19, ICFPM_USER_20, ICFPM_USER_21, ICFPM_USER_22, ICFPM_USER_23, ICFPM_USER_24, ICFPM_USER_25, ICFPM_USER_26, ICFPM_USER_27, ICFPM_USER_28, ICFPM_USER_29, ICFPM_USER_30, ICFPM_USER_31, ICFPM_USER_32, ITF_CODE, KIT_LT, LOT_CONTROL, MAX_ORDER_QTY, MFG_LT, MIN_SALES_QTY, MODIFIED_BY, MPS_CODE, MRP_FLAG, NOTES, OPERATOR_ID, ORDER_QTY, ORIG_COUNTRY, ORIG_REL_DATE, PACK_SIZE, PART_CLASS, PART_DESC, PART_HOLD_CODE, PART_ID, PART_STATUS, PART_TYPE, PART_UM, PENDING_ECN, PLAN_HORIZON, PLAN_LEAD_TIME, PLANNER_ID, PREF_VENDOR, PRICE_CONV, PRICE_UM, PRODUCT_LINE, QC_FLAG, QTY_PER_CARTON, RECEIVING_LT, ROHS_COMP_COMM, ROHS_COMP_DATE, ROHS_COMP_ST, ROHS_DOC_COMM, ROHS_DOC_DATE, ROHS_DOC_ST, ROHS_PROC_COMM, ROHS_PROC_DATE, ROHS_PROC_ST, SALE_CONV, SALE_DEC, SALE_UM, SALES_MARKET, SEARCH_NAME, SHELF_LIFE, SHIP_LT, SHIP_TYPE, SLX_PART, SN_REQD, SN_REQD_INV, SO_ORDER_QTY, STD_1_HRS, STD_2_HRS, STD_3_HRS, STD_LAB_CST_ADD, STD_LAB_CST_CUM, STD_LAB_HRS_ADD, STD_LAB_HRS_CUM, STD_MTL_CST_ADD, STD_MTL_CST_CUM, STD_OH_PCT_BUY, STD_OH_PCT_OUT, STD_OHD_CST_ADD, STD_OHD_CST_CUM, STD_OTH_CST_ADD, STD_OTH_CST_CUM, STD_OUT_CST_ADD, STD_OUT_CST_CUM, STD_UNIT_COST, STD_WORK_1, STD_WORK_2, STD_WORK_3, STOCK_DEC, SUBST_PART, TAXABLE, TIME_LAST_UPDT, UPC_CODE, VAT_CODE, VENDR_LEAD_TIME, VOLUME, WARRANTY_DAYS, WEEE_RECY_COMM, WEEE_RECY_DATE, WEEE_RECY_ST, WEIGHT, YIELD_FACTOR