This doc is automatically generated. You can get your access token from "Access Keys" or contact support@globalreader.eu

API Documentation

ApisWeb.OrderController
- create
ApisWeb.ProductionController
- by_device
ApisWeb.StatsController
- by_shift

ApisWeb.OrderController

<a id=apisweb-ordercontroller-create></a>create

Create multiple production orders

Request

Method: POST
Path: /api/v1/orders

Request headers:

authorization: Bearer a7b495fa-fe5c-4685-a15c-10bd21e751e8
content-type: application/json; charset=utf-8

Request body:

[
  {
    "comment": "test comment",
    "data": {
      "some": "additional data can be sent"
    },
    "due_at": "2020-06-01T10:00:00+03:00",
    "name": "Production name",
    "order_remote_id": "726a040d-e11d-47e9-ba23-9bf14af1af95",
    "planned_duration": 807,
    "planned_end_at": "2020-06-01T17:43:41+03:00",
    "planned_quantity": 1000,
    "planned_start_at": "2020-06-01T17:30:13+03:00",
    "priority": 1,
    "product": {
      "code": "TEST-123456",
      "max_production": 80,
      "min_production": 10,
      "multiplier": 1,
      "name": "TestProduct"
    },
    "product_code": "TEST-123456",
    "production_code": "AB12345",
    "status": 0,
    "workstation_uid": "e42ca6d8-8961-441a-8401-8c8b9f68c6ee"
  }
]

Response

Status: 200

Response headers:

content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate

Response body:

[
  {
    "order_remote_id": "726a040d-e11d-47e9-ba23-9bf14af1af95",
    "result": "ok"
  }
]

Invalid data example

Request

Method: POST
Path: /api/v1/orders

Request headers:

content-type: application/json
authorization: Bearer 1de78de6-d88c-4525-b5ab-5c39d96cb0b4

Request body:
```
{
  "name": "Production name"
}
```

Response

Status: 200

Response headers:

content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate

Response body:

{
  "errors": "workstation_uid can not be empty",
  "result": "error"
}

ApisWeb.ProductionController

<a id=apisweb-productioncontroller-by_device></a>by_device

List production orders by device uid

Request

Method: GET
Path: /api/v1/order_productions/by_device?device=ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed&end=1586260800&start=1586250000&token=524de5be-b1b7-4a64-af40-6f89f4998643

Response

Status: 200

Response headers:

content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate

Response body:

[
  {
    "end_at": "2020-04-07T11:00:00Z",
    "operator_code": "SA1",
    "order_id": 6613,
    "order_product_code": "code38",
    "order_product_name": "product37",
    "order_production_code": "225566",
    "order_remote_id": "563730272156371899105637313521",
    "production_status": 2,
    "productions": [
      {
        "duration": 600,
        "duration_schi_exc": 600,
        "end_at": "2020-04-07T09:11:00Z",
        "entered_amount": 10.0,
        "id": 3454,
        "operator_code": "SA1",
        "operators": [
          {
            "code": "SA1",
            "name": "Sally"
          }
        ],
        "production_status": 2,
        "run_time": 480,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T09:03:00Z",
        "setup_time": 120,
        "start_at": "2020-04-07T09:01:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T09:11:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T10:30:00Z",
        "entered_amount": 0,
        "id": 3455,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1800,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": null,
        "setup_time": 0,
        "start_at": "2020-04-07T10:00:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T10:30:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T11:00:00Z",
        "entered_amount": 0,
        "id": 3456,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1500,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T10:35:00Z",
        "setup_time": 300,
        "start_at": "2020-04-07T10:30:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T11:00:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      }
    ],
    "sensor_unit": null,
    "start_at": "2020-04-07T09:01:00Z",
    "total_duration": 4200,
    "total_duration_schi_exc": 4200,
    "total_entered_amount": 10.0,
    "total_measured_amount": 0,
    "total_run_time": 3780,
    "total_scrap_amount": 0,
    "total_setup_time": 420
  },
  {
    "end_at": "2020-04-07T11:00:00Z",
    "operator_code": "SA1",
    "order_id": 6613,
    "order_product_code": "code38",
    "order_product_name": "product37",
    "order_production_code": "225566",
    "order_remote_id": "563730272156371899105637313521",
    "production_status": 2,
    "productions": [
      {
        "duration": 600,
        "duration_schi_exc": 600,
        "end_at": "2020-04-07T09:11:00Z",
        "entered_amount": 10.0,
        "id": 3454,
        "operator_code": "SA1",
        "operators": [
          {
            "code": "SA1",
            "name": "Sally"
          }
        ],
        "production_status": 2,
        "run_time": 480,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T09:03:00Z",
        "setup_time": 120,
        "start_at": "2020-04-07T09:01:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T09:11:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T10:30:00Z",
        "entered_amount": 0,
        "id": 3455,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1800,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": null,
        "setup_time": 0,
        "start_at": "2020-04-07T10:00:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T10:30:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T11:00:00Z",
        "entered_amount": 0,
        "id": 3456,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1500,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T10:35:00Z",
        "setup_time": 300,
        "start_at": "2020-04-07T10:30:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T11:00:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      }
    ],
    "sensor_unit": null,
    "start_at": "2020-04-07T09:01:00Z",
    "total_duration": 4200,
    "total_duration_schi_exc": 4200,
    "total_entered_amount": 10.0,
    "total_measured_amount": 0,
    "total_run_time": 3780,
    "total_scrap_amount": 0,
    "total_setup_time": 420
  },
  {
    "end_at": "2020-04-07T11:00:00Z",
    "operator_code": "SA1",
    "order_id": 6613,
    "order_product_code": "code38",
    "order_product_name": "product37",
    "order_production_code": "225566",
    "order_remote_id": "563730272156371899105637313521",
    "production_status": 2,
    "productions": [
      {
        "duration": 600,
        "duration_schi_exc": 600,
        "end_at": "2020-04-07T09:11:00Z",
        "entered_amount": 10.0,
        "id": 3454,
        "operator_code": "SA1",
        "operators": [
          {
            "code": "SA1",
            "name": "Sally"
          }
        ],
        "production_status": 2,
        "run_time": 480,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T09:03:00Z",
        "setup_time": 120,
        "start_at": "2020-04-07T09:01:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T09:11:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T10:30:00Z",
        "entered_amount": 0,
        "id": 3455,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1800,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": null,
        "setup_time": 0,
        "start_at": "2020-04-07T10:00:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T10:30:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T11:00:00Z",
        "entered_amount": 0,
        "id": 3456,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1500,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T10:35:00Z",
        "setup_time": 300,
        "start_at": "2020-04-07T10:30:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T11:00:00Z",
        "workstation_name": "Device105",
        "workstation_uid": "ef1e2695-2baf-4bef-a062-a1fc0ba9b3ed"
      }
    ],
    "sensor_unit": null,
    "start_at": "2020-04-07T09:01:00Z",
    "total_duration": 4200,
    "total_duration_schi_exc": 4200,
    "total_entered_amount": 10.0,
    "total_measured_amount": 0,
    "total_run_time": 3780,
    "total_scrap_amount": 0,
    "total_setup_time": 420
  }
]

List production orders by device group

Request

Method: GET
Path: /api/v1/order_productions/by_device?device_group=61cdfcd4-c000-4e6a-848a-8437026c3c03&end=1586253600&start=1586250000&token=01e45679-038d-4288-8ef2-1eb9fc17cbb6

Response

Status: 200

Response headers:

content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate

Response body:

[
  {
    "end_at": "2020-04-07T11:00:00Z",
    "operator_code": "SA1",
    "order_id": 6616,
    "order_product_code": "code98",
    "order_product_name": "product97",
    "order_production_code": "225566",
    "order_remote_id": "563730272156371899105637313521",
    "production_status": 2,
    "productions": [
      {
        "duration": 600,
        "duration_schi_exc": 600,
        "end_at": "2020-04-07T09:11:00Z",
        "entered_amount": 10.0,
        "id": 3463,
        "operator_code": "SA1",
        "operators": [
          {
            "code": "SA1",
            "name": "Sally"
          }
        ],
        "production_status": 2,
        "run_time": 480,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T09:03:00Z",
        "setup_time": 120,
        "start_at": "2020-04-07T09:01:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T09:11:00Z",
        "workstation_name": "Device285",
        "workstation_uid": "03f40e37-e5ab-47c7-aa10-4c9aa34557eb"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T10:30:00Z",
        "entered_amount": 0,
        "id": 3464,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1800,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": null,
        "setup_time": 0,
        "start_at": "2020-04-07T10:00:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T10:30:00Z",
        "workstation_name": "Device285",
        "workstation_uid": "03f40e37-e5ab-47c7-aa10-4c9aa34557eb"
      },
      {
        "duration": 1800,
        "duration_schi_exc": 1800,
        "end_at": "2020-04-07T11:00:00Z",
        "entered_amount": 0,
        "id": 3465,
        "operator_code": null,
        "operators": [],
        "production_status": 2,
        "run_time": 1500,
        "scraps": [],
        "sensor_unit": null,
        "setup_end_at": "2020-04-07T10:35:00Z",
        "setup_time": 300,
        "start_at": "2020-04-07T10:30:00Z",
        "total_measured_amount": 0,
        "updated_at": "2020-04-07T11:00:00Z",
        "workstation_name": "Device285",
        "workstation_uid": "03f40e37-e5ab-47c7-aa10-4c9aa34557eb"
      }
    ],
    "sensor_unit": null,
    "start_at": "2020-04-07T09:01:00Z",
    "total_duration": 4200,
    "total_duration_schi_exc": 4200,
    "total_entered_amount": 10.0,
    "total_measured_amount": 0,
    "total_run_time": 3780,
    "total_scrap_amount": 0,
    "total_setup_time": 420
  }
]

ApisWeb.StatsController

<a id=apisweb-statscontroller-by_shift></a>by_shift

Fetch shift statistics

Request

Method: GET
Path: /api/v1/stats/by_shift?end=1585137600&start=1584925200&token=a54ac7e6-03aa-424a-a75c-661a85c859ab&workstation=d9324070-276a-4af3-9c40-6989f2e7bf68

Response

Status: 200

Response headers:

content-type: application/json; charset=utf-8
cache-control: max-age=0, private, must-revalidate

Response body:

[
  {
    "active_min": 2.0,
    "amount": 8.0,
    "availability_percent": 0.0,
    "avg_amount": 4.0,
    "avg_amount_total": 4.0,
    "duration_min": 780,
    "end_at": "2020-03-24T02:00:00Z",
    "int_defined_min": 0.0,
    "int_min": 0.0,
    "int_planned_min": 0.0,
    "int_rec_min": 6.0,
    "int_udef_min": 0.0,
    "loading_count": 0,
    "loading_min": 0.0,
    "max_production": 0.0,
    "oee_percent": 0.0,
    "oee_sensor_unit": null,
    "oee_target": 0.0,
    "performance_percent": 0.0,
    "planned_prod_min": -4.0,
    "quality_percent": 0.0,
    "run_min": 2.0,
    "shift_min": 2.0,
    "shift_name": "shiftlog0",
    "shift_uid": "80d133c7-52a1-4b19-b7dd-5f979a816c11",
    "shiftlog_uid": "69208ed0-8d92-4e40-8e68-d607ea680943",
    "start_at": "2020-03-23T13:00:00Z",
    "total_amount": 0.0,
    "workstation_name": "Device768",
    "workstation_serial": "serial769",
    "workstation_uid": "d9324070-276a-4af3-9c40-6989f2e7bf68"
  }
]