api/SerialNumberCrossReference/Query (POST)
Queries existing Serial Number Cross Reference 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 Serial Number Cross References.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Serial Number Cross Reference query data.
Query Single Serial Number Cross Reference Using Key Fields Example:
{
"ASSEMBLY_ID": "ASSY002",
"ASSEMBLY_SN": "02022016-0001",
"COMPONENT_ID": "COMP002",
"COMPONENT_SN": "02022016-0001"
}
Returns 1 Serial Number Cross Reference if successful.
This is like 'Find' in Expandable.
Query Multiple Serial Number Cross References Using Other Fields Example:
{
"ORDER_ID": "S123456",
"LINE_NUMBER": "20"
}
Returns 1 or more Serial Number Cross References if successful.
This is like 'QBE' in Expandable.
Query Multiple Serial Number Cross References Using QBE Conditional Notation Example:
{
"RA_REASON": "IN 'SR','ER'"
}
Returns 1 or more Serial Number Cross References if successful.
This is like 'QBE' in Expandable.
Accepted Serial Number Cross Reference Fields:
ASSEMBLY_ID, ASSEMBLY_SN, COMMENT, COMPONENT_ID,
COMPONENT_SN, CREATED_BY, DATE_CREATED, DATE_LAST_UPDT,
DATE_MODIFIED, END_DATE, LINE_NUMBER, MODIFIED_BY,
OPERATOR_ID, ORDER_ID, RA_REASON, REFERENCE,
START_DATE, TIME_LAST_UPDT |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON array with found Serial Number Cross References.
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 Serial Number Cross Reference Fields:
ASSEMBLY_ID, ASSEMBLY_SN, COMMENT, COMPONENT_ID, COMPONENT_SN, CREATED_BY, DATE_CREATED, DATE_LAST_UPDT, DATE_MODIFIED, END_DATE, LINE_NUMBER, MODIFIED_BY, OPERATOR_ID, ORDER_ID, RA_REASON, REFERENCE, START_DATE, TIME_LAST_UPDT