REST API Inspection - Industry4/MultiPlug.Ext.Hermes GitHub Wiki

<<- Back to REST API Home

Index

Delete Board
All Boards
First Board
Last Board
Query Board
Action Board
Invoke Action Board

Delete Board

Description

Deletes a Board from the Inspection Station Queue

URL

POST /api/multiplug.ext.hermes/inspection/boards/delete/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.
String guid The Guid of the Board

HTTP Response Codes

200 OK
422 Unprocessed - Lane Not Found. If lane guid not specified, no lanes are setup.
422 Unprocessed - Missing Board Guid
422 Unprocessed - Board Not Found
403 Forbidden - API Not Enabled

All Boards

Description

Returns all Boards from Inspection Station Queue

URL

GET /api/multiplug.ext.hermes/inspection/boards/all/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

[
    {
        "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
        "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
        "boardIdCreatedBy": "DEK NeoHorizon",
        "failedBoard": 1,
        "productTypeId": "Product Type 01",
        "flippedBoard": 1,
        "topBarcode": "0123456789",
        "bottomBarcode": "9876543210",
        "length": 2.0,
        "width": 1.0,
        "thickness": 3.0,
        "conveyorSpeed": 4.0,
        "topClearanceHeight": 5.0,
        "bottomClearanceHeight": 6.0,
        "weight": 7.0,
        "workOrderId": "Work Order 02",
        "batchId": "0001"
    }
]

HTTP Response Codes

200 OK
400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
403 Forbidden - API Not Enabled

First Board

Description

Returns the First Board from Inspection Station Queue

URL

GET /api/multiplug.ext.hermes/inspection/boards/first/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
    "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "productTypeId": "Product Type 01",
    "flippedBoard": 1,
    "topBarcode": "0123456789",
    "bottomBarcode": "9876543210",
    "length": 2.0,
    "width": 1.0,
    "thickness": 3.0,
    "conveyorSpeed": 4.0,
    "topClearanceHeight": 5.0,
    "bottomClearanceHeight": 6.0,
    "weight": 7.0,
    "workOrderId": "Work Order 02",
    "batchId": "0001"
}

HTTP Response Codes

200 OK
400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
400 Bad Request - First Board Not Found
403 Forbidden - API Not Enabled

Last Board

Description

Returns the Last Board from Inspection Station Queue

URL

GET /api/multiplug.ext.hermes/inspection/boards/last/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
    "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "productTypeId": "Product Type 01",
    "flippedBoard": 1,
    "topBarcode": "0123456789",
    "bottomBarcode": "9876543210",
    "length": 2.0,
    "width": 1.0,
    "thickness": 3.0,
    "conveyorSpeed": 4.0,
    "topClearanceHeight": 5.0,
    "bottomClearanceHeight": 6.0,
    "weight": 7.0,
    "workOrderId": "Work Order 02",
    "batchId": "0001"
}

HTTP Response Codes

200 OK
400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
400 Bad Request - Last Board Not Found
403 Forbidden - API Not Enabled

Query Board

Description

Returns a Board record with the specified Top or Bottom Barcode

URL

GET /api/multiplug.ext.hermes/inspection/boards/query/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.
String guid Optional. The Guid of the Board
String topbarcode Optional. The Top Barcode of the Board
String bottombarcode Optional. Bottom Barcode of the Board

Note: Either guid, topbarcode or bottombarcode should be used.

JSON Response Example

{
    "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
    "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "productTypeId": "Product Type 01",
    "flippedBoard": 1,
    "topBarcode": "0123456789",
    "bottomBarcode": "9876543210",
    "length": 2.0,
    "width": 1.0,
    "thickness": 3.0,
    "conveyorSpeed": 4.0,
    "topClearanceHeight": 5.0,
    "bottomClearanceHeight": 6.0,
    "weight": 7.0,
    "workOrderId": "Work Order 02",
    "batchId": "0001"
}

HTTP Response Codes

200 OK
400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
400 Bad Request - Board Not Found
403 Forbidden - API Not Enabled

Action Board

Description

Returns all possible User Actions

URL

GET /api/multiplug.ext.hermes/inspection/boards/action/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.
String guid. The Guid of the Board

JSON Response Example

{
    "guid": "0b4c23c1-d991-4c13-9709-b4c6a9f3bf38",
    "reason": "Failed Board is Equal to 2",
    "actions": [
        {
            "guid": "8bda",
            "text": "PASS"
        },
        {
            "guid": "5427",
            "text": "FAIL"
        }
    ]
}

HTTP Response Codes

200 OK
400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
400 Bad Request - Missing Board Guid
400 Bad Request - Board Not Found
403 Forbidden - API Not Enabled

Invoke Action Board

Description

Invokes a User Action

URL

POST /api/multiplug.ext.hermes/inspection/boards/action/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.
String guid The Guid of the Board
String actionguid The Guid of the Action

HTTP Response Codes

200 OK
422 Unprocessed - Lane Not Found. If lane guid not specified, no lanes are setup.
422 Unprocessed - Missing Board Guid
422 Unprocessed - Missing Action Guid
422 Unprocessed - Action Not Found
403 Forbidden - API Not Enabled