API Endpoints

List of API Endpoints:

• /register-delivery
• /delivery-list
• /product-list
• /product-info/{product_ident}
• /create-job
• /job-result/{job_uuid}
• /job-result-pdf/{job_uuid}
• /job-history/{delivery_id}

/register-delivery

Register a new delivery from already uploaded file

• Method: POST
• Parameters: apikey (unique user api-key)
• Request body: uploaded_file (path to the delivery file - visible in the docker container, for example: /mnt/qc_tool_uploads/uploads/delivery.zip)
• Response: application/json (status, message, delivery_id)

/delivery-list

List all deliveries

• Method: GET
• Parameters: apikey (unique user api-key)
• Response: application/json (status, message, deliveries)

/product-list

List all products that can be checked

• Method: GET
• Parameters: apikey (unique user api-key)
• Response: application/json (status, message, products)

/product-info/{product_ident}

Show all QC checks for a product

• Method: GET
• Parameters: apikey (unique user api-key); product_ident (the product ident to show information about)
• Response: application/json (status, message, data)

/create-job

Run a new QC job

• Method: POST
• Parameters: apikey (unique user api-key)
• Request body: delivery_id (for example 1); product_ident (for example "cz_2018"); skip_steps (for example "8,9")
• Note that the skip_steps parameter is optional. To run all steps, set skip_steps to "".
• Response: application/json (status, message, job_uuid)

/job-result/{job_uuid}

Specific job results in json format

• Method: GET
• Parameters: apikey (unique user api-key); job_uuid (the uuid to get results of)
• Response: application/json (status, message, data)

/job-result-pdf/{job_uuid}

Specific job results in pdf format

• Method: GET
• Parameters: apikey (unique user api-key); job_uuid (the uuid to get results of)
• Response: application/pdf (pdf file that can be downloaded)

/job-history/{delivery_id}

Specific delivery job history

• Method: GET
• Parameters: apikey (unique user api-key); delivery_id (the delivery_id to get history of)
• Response: application/json (status, message, data)