REST API

Our REST API is designed to insert data into the Tascus database, and query status of items in the Tascus database.

A REST API (Representational State Transfer Application Programming Interface) is a set of rules and conventions for building and interacting with web services.

1. HTTP Methods: REST APIs use standard HTTP methods (such as GET, POST, PUT, DELETE) to perform actions on resources. For example:

   • GET: Retrieve data from a resource.

   • POST: Create a new resource.

   • PUT: Update an existing resource.

   • DELETE: Remove a resource.

2. Uniform Interface: REST APIs follow a uniform interface, which includes:

   • Resource URIs: URLs that uniquely identify resources.

   • HTTP Methods: Used to perform actions on resources.

   • HTTP Status Codes: Indicate the outcome of the request (e.g., 200 OK, 404 Not Found).

   • Representation: JSON format is used to exchange information.

ProductResult

GET /ProductResults

• Purpose: Returns the production step results for a product.

• Example Request: {{Tascus Base Url}}/ProductResults?Part_Number=G090L&Serial_Number=0021116&Operation_ID=1000

• Query Parameters:

  • Part_Number: G090L

  • Serial_Number: 0021116

  • Operation_ID: 1000

• Response:

[
    {
        "step_Name": "Work Instruction",
        "step_Measurement": "Pick Parts Tray",
        "step_Result": "Complete",
        "high_Limit": "",
        "low_Limit": "",
        "step_Status": "PASS",
        "unit": "",
        "step_Run": 1,
        "operation_Name": "Picking",
        "operation_ID": 1000,
        "date": "2023-05-11T06:40:48"

    }
]

POST /ProductResults

• Purpose: Adds production step results for a product. Example Request Body:

• Example Request Body:

{
  "step_Name": "Test Step Name",
  "step_Measurement": "Test Step Measurement",
  "step_Result": "PASS",
  "high_Limit": "Test High Limit",
  "low_Limit": "Test Low Limit",
  "step_Status": "EXECUTING",
  "unit": "Test Unit",
  "step_Run": 0,
  "operation_Name": "Test Operation Name",
  "operation_ID": 1000,
  "serial_Number": "0021116",
  "part_Number": "G090L",
  "date": "2023-08-04T13:32:27.472Z"
}

• Response:

{
    "message": "Product Result Created Successfully."
}

ProductStatus

GET /ProductStatus

• Purpose: Get the Status of a manufacturing operation for a product.

• Example Request: {{Tascus Base Url}}/ProductStatus?Part_Number=G090L&Serial_Number=0021116&Operation_ID=1000

• Query Parameters:

  • Part_Number: G090L

  • Serial_Number: 0021116

  • Operation_ID: 1000

• Response:

[
    {
        "status": "EXECUTING",
        "result": "FAIL"
    }
]

PUT /ProductStatus

• Purpose: Updates the result and status string for a product.

• Request URL: {{Tascus Base Url}}/ProductStatus

• Example Request Body:

{
  "model_Number": "G090L",
  "serial_Number": "0021116",
  "status": "EXECUTING",
  "result": "FAIL",
  "operation_ID": 1000
}

• Response:

{
    "message": "Product Status updated successfully."
}