apidocs.datacheck.it Open in urlscan Pro
35.175.0.27  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings
Environment
No Environment
Layout
Double Column
Language
cURL



QUALITY PLUS LIMS PUBLIC REST API

 * Introduction
 * Description
 * Questions, comments and suggestions
 * REST API Specifications


Products

Formulas

Companies

Attachments

Analysis Requests
QUALITY PLUS LIMS Public REST API

Welcome to DATACHECK QUALITY PLUS LIMS (Laboratory Information Management LIMS)
public REST API.

This set of API is managed and documented with Postman.


SETUP

Follow instruction contained in our product documentation and refert to the
System Installation Specification.


API AVAILABILITY

The REST API webserver is available starting from QUALITY PLUS v16.


CONVENTIONS

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be
interpreted as described in RFC 2119.


DESCRIPTION


SECURITY

[To be completed]


RESPONSES

A standard successful response of QUALITY PLUS API must be made like this:

View More

{
    "success" : true,
    "data"    : {
        "[entity_name]" : {
            "id":1,
            "[property_name]":"stringdata",
            "[property_name]":0
        }
    },
    "message": {
        "code": 0,
        "text": "Data found",
        "local_msg": "Dati trovati",
        "local_lang": "it"
    }



}


Each response shall be composed by three keys:



Name Description Required success true if the request was successful or false if
not Yes data contain the returned data, it can be null Yes message report error
code and message, required only if success is false No


DATA KEY

The data key must contain the response data.

Data key may be null if no data is returned

"data" : null


MESSAGE KEY

The code key must contain the error reference code and text message. The text
key shall be present even if the response has succeeded, error code:0 means no
error, any value greater then zero rapresent an error (success key value must be
false). The message key should describe the error meaning, a localized version
may appear:

   
 * local_msg: the error message in the local language
   
 * loca_lang: the local language id
   


STATUS

QUALITY PLUS API will return 200 OK status for each request managed, even if the
service will not able to excute the requested operation.

An error status will be returned only in case of authoriration errors, erroneus
requests and server side errors.

Status Description 200 OK The request was managed by the server, may return no
data or error messages. You must always check the success key. 400 Bad Request
401 Unauthorized 403 Forbidden 500 Internal Server Error 501 Service Unavailable


ENTITIES

Many request are related to an application entity or record type, the following
table list entities names and description. Entity names are always plural and
are used in request endpoints.

Name Description analysis Analysis requests attachments Common entity, attacched
document or memo to another entity companies Business partners companies, could
be Supplier, producer or customer products Describe a product bought or produced
by the company / plant


QUESTIONS, COMMENTS AND SUGGESTIONS

If you have any questions or comments, please let us know at
support@datacheck.it.


REST API SPECIFICATIONS



Products

usecomptype fields can assume these values, with following meanings:

uctUndefine = not defined uctTecnicSost = technical secondary substance
uctCompens = compensation component uctToDeclare = substance to be declared
uctImpurity) = impurity


GET

Get product by code

{{url}}/api/products?code=A0011061

Return the approved version of the product with the specified code, if exist.

PARAMS
code
A0011061

Item code



Example Request
Get product by code

curl --location -g --request GET '{{url}}/api/products?code=A0011061'

Example Response
200 OK
Body
Header(6)
View More

{
  "success": true,
  "data": [
    {
      "code": "A0011061",
      "version": 0,
      "description": "MATERIA PRIMA",
      "itemclass": "MP",
      "cost": 27.61,
      "currency": "EUR",
      "statorev": 1,

POST

Insert new product

{{url}}/api/products
HEADERS
Content-Type
application/json
BODYraw
View More

{
	"code": "A0011061",
    "description": "MATERIA PRIMA ",
    "itemclass": "MP",
    "cost": 27.61,
    "currency": "EUR",
    "components": [
        {
            "description": "Componente A",
            "casnumber": "11111",
            "inciname": "Componente A",



Example Request
Insert new product
View More

curl --location -g --request POST '{{url}}/api/products' \
--header 'Content-Type: application/json' \
--data-raw '{
	"code": "A0011061",
    "description": "MATERIA PRIMA ",
    "itemclass": "MP",
    "cost": 27.61,
    "currency": "EUR",
    "components": [
        {
            "description": "Componente A",

PUT

Update a product

{{url}}/api/products/:code
HEADERS
Content-Type
application/json
PATH VARIABLES
code

BODYraw
View More

{
    "description": "MATERIA PRIMA ",
    "itemclass": "MP",
    "cost": 27.61,
    "currency": "EUR",
    "components": [
        {
            "description": "Componente A",
            "casnumber": "11111",
            "inciname": "Componente A",
            "functionslist": "SOLVENT",



Example Request
Update a product
View More

curl --location -g --request PUT '{{url}}/api/products/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "MATERIA PRIMA ",
    "itemclass": "MP",
    "cost": 27.61,
    "currency": "EUR",
    "components": [
        {
            "description": "Componente A",
            "casnumber": "11111",

Formulas


GET

Get formula by code

{{url}}/api/formulas?code=ABP001323A

Return the approved version of the product with the specified code, if exist.

PARAMS
code
ABP001323A

Item code



Example Request
Get formula by code

curl --location -g --request GET '{{url}}/api/formulas?code=ABP001323A'

Example Response
200 OK
Body
Header(6)
View More

{
  "success": true,
  "data": [
    {
      "code": "ABP001323A",
      "version": 0,
      "description": "OMBRETTO COTTO",
      "targetoutput": "1000",
      "unitmis": "g",
      "ingredients": [
        {

POST

Insert new formula

{{url}}/api/formulas
HEADERS
Content-Type
application/json
BODYraw
View More

{
	"code": "ABP001323A",
    "description": "OMBRETTO COTTO",
    "targetoutput": "1000",
    "unitmis": "g",
    "ingredients": [
        {
            "ingredientcode": "Z000",
            "description": "Water",
            "functionid": "",
            "percpartecip": 90,



Example Request
Insert new formula
View More

curl --location -g --request POST '{{url}}/api/formulas' \
--header 'Content-Type: application/json' \
--data-raw '{
	"code": "ABP001323A",
    "description": "OMBRETTO COTTO",
    "targetoutput": "1000",
    "unitmis": "g",
    "ingredients": [
        {
            "ingredientcode": "Z000",
            "description": "Water",

PUT

Update a formula

{{url}}/api/formulas/:code
HEADERS
Content-Type
application/json
PATH VARIABLES
code

BODYraw
View More

{
    "description": "OMBRETTO COTTO",
    "targetoutput": "1000",
    "unitmis": "g",
    "ingredients": [
        {
            "ingredientcode": "Z000",
            "description": "Water",
            "functionid": "",
            "percpartecip": 90,
            "qtapartecip": 90,



Example Request
Update a formula
View More

curl --location -g --request PUT '{{url}}/api/formulas/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "OMBRETTO COTTO",
    "targetoutput": "1000",
    "unitmis": "g",
    "ingredients": [
        {
            "ingredientcode": "Z000",
            "description": "Water",
            "functionid": "",

GET

Get active formula by productcode

No request URL found. It will show up here once added.



Example Request
Get active formula by productcode

curl --location --request GET ''

Companies


GET

Retrieve all companies

{{url}}/api/companies



Example Request
Retrieve all companies

curl --location -g --request GET '{{url}}/api/companies'

GET

Retrieve company by ID

{{url}}/api/companies/:id

Companies related requests

PATH VARIABLES
id

Company Unique ID



Example Request
Company - 200 response

curl --location --request GET '/api/companies/5'

Example Response
200 OK
Body
Header(15)
View More

{
  "success": true,
  "data": {
    "company": {
      "id": 5,
      "code": "",
      "type": 0,
      "name": "DATA CHECK srl",
      "address1": "Via Monti Berici, 6",
      "address2": "",
      "zipcode": "37057",

POST

Create a company

{{url}}/api/companies



Example Request
Create a company

curl --location -g --request POST '{{url}}/api/companies'

PUT

Update a company

{{url}}/api/companies/:id
PATH VARIABLES
id

Company unique ID



Example Request
Update a company

curl --location -g --request PUT '{{url}}/api/companies/'

DEL

Delete a company

{{url}}/api/companies/:id
PATH VARIABLES
id

Company unique id



Example Request
Delete a company

curl --location -g --request DELETE '{{url}}/api/companies/'

Attachments

Requests about attachments


GET

Get all attachments of an entity

{{url}}/api/:entity/attachments?changedafter=20181030T10:05:00Z

Returns all attachmnets for the specified entity type (i.e. products), filter by
date may be used (changed after).

PARAMS
changedafter
20181030T10:05:00Z

Documents changed after that datetime (ISO-8601 format)

PATH VARIABLES
entity
products

Entity name



Get all attachments of an entity changed after 20190703T083000Z - data found
Example Request

curl --location -g --request GET '{{url}}/api/products/attachments?changedafter=%2220190730T083000Z%22'

Example Response
200 OK
Body
Header(0)
View More

{
  "success": true,
  "data": {
    "attachments": [
      {
        "key": "XXXXX|XX|XX",
        "num": 1,
        "title": "Titolo dell'allegato",
        "author": "Mario Rossi",
        "authorid": "marossi",
        "type": 0,

GET

Get all attachments of an entity item

{{url}}/api/:entity/:id/attachments

Get all attachments of an entity istance

PATH VARIABLES
entity
products

Entity name

id
1

Entity identity ID



Example Request
Get all attachments of an entity item

curl --location -g --request GET '{{url}}/api/products/1/attachments'

GET

Get one attachment

{{url}}/api/:entity/attachments/:id
PATH VARIABLES
entity
products

Entity name

id
601

Attachment identity ID



Example Request
Get one attachment

curl --location -g --request GET '{{url}}/api/products/test/attachments/1'

GET

Download one attachment file

{{url}}/api/:entity/attachments/:id/download
PATH VARIABLES
entity
products

Entity name

id
1

Attachment identity ID



Example Request
Download one attachment file

curl --location -g --request GET '{{url}}/api/products/attachments/1/download'

Analysis Requests