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

<<- Back to REST API Home

Index

SMEMA Board Available

Description

Returns the SMEMA Good or Bad Board Available I/O State

URL

GET /api/multiplug.ext.hermes/down/smema/

Data

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

JSON Response Example

{
    "good": false,
    "bad": false
}

HTTP Response Codes

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

Set SMEMA Good Board Available

Description

Sets the SMEMA Good Board Available

URL

POST /api/multiplug.ext.hermes/down/smema/good/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.
Bool ready Options: true false

JSON Response Example

{
    "good": true,
    "bad": false
}

HTTP Response Codes

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

Set SMEMA Bad Board Available

Description

Sets the SMEMA Bad Board Available I/O State

URL

POST /api/multiplug.ext.hermes/down/smema/bad/

Data

String lane Optional. Guid of the Lane. If not specified then first lane will be used.
Bool ready Options: true false

JSON Response Example

{
    "good": false,
    "bad": true
}

HTTP Response Codes

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

Delete Board

Description

Deletes a Board from the Downstream Queue

URL

POST /api/multiplug.ext.hermes/down/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 the Downstream Queue

URL

GET /api/multiplug.ext.hermes/down/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 the Downstream Queue

URL

GET /api/multiplug.ext.hermes/down/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 the Downstream Queue

URL

GET /api/multiplug.ext.hermes/down/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/down/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

Hermes Service Description

Description

Returns the Hermes Service Description from the Downstream Connection

URL

GET /api/multiplug.ext.hermes/down/hermes/servicedescription/

Data

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

JSON Response Example

{
    "machineId": "???DownstreamSimulation",
    "laneId": 1,
    "interfaceId": "DownstreamInterface",
    "version": "1.3",
    "supportedFeatures": {
        "featureCheckAliveResponse": true,
        "featureBoardForecast": true,
        "featureQueryBoardInfo": true,
        "featureSendBoardInfo": false,
        "featureCommand": false
    }
}

HTTP Response Codes

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

Restart Hermes Connection

Description

Reconnects the Downstream Hermes connection

URL

POST /api/multiplug.ext.hermes/down/hermes/connection/restart

Data

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

HTTP Response Codes

200 OK
403 Forbidden - API Not Enabled