API Endpoints

List of API Endpoints:

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

/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)

/register-delivery-s3

Register a new delivery from S3 storage

• Method: POST
• Parameters: apikey (unique user api-key)
• Request body: host (S3 storage host, for exapmle: "https://s3.waw3-1.cloudferro.com"); access_key (S3 access key, for example: "dasldkQ123"); secret_key (S3 secret key, for example: "35H12refsaadf"); bucketname (name of the S3 bucket, for example: "delivery"); key_prefix (delivery S3 key prefix, for example: "20231127/TCD/CLMS_HRL_VLCC_TCD_S2020_R10m_E49N35_03035_V01_R00")
• Response: application/json (status, message, delivery_id)

/delivery-list

List all deliveries

• Method: GET
• Parameters: apikey (unique user api-key)

• Optional query parameters:

  • offset (number of items to skip before showing current result set, default=20),
  • limit(number of items in the current resultset, default=20),
  • sort (the attribute to sort the result by, default=id),
  • order (the sorting order - desc or asc, default=desc)

• Response: application/json

  • status
  • message
  • total (the total number of deliveries of the current user)
  • offset (the offset parameter used for the current result set)
  • limit (the limit parameter used for the current result set)
  • next_offset (the offset parameter to used for the next page of results)
  • deliveries (the list of 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)

/submit-delivery-to-eea

Submission of deliveries to qc_tool_submission folder

• Method: POST
• Parameters: apikey (unique user api-key); delivery_id (the delivery_id to submit the reports of)
• Response: application/json (status, message)
• Note: Deliveries are copied to the 'qc_tool_submission' folder. In the case of S3 deliveries, only reports and supporting files (such as logfile, config JSON file or timestamp textfile) are copied.