Skip to content
API
/
Verification
/
/api/v1/verification/workflow/barcode

ML Prep API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

http://{{your_prep_ip_address}}/

Authenticate

Operations

Backups

Operations

Calibration

Operations

Camera

Operations

Configuration

Operations

Credentials

Operations

Deck

Operations

Diagnostics

Operations

Enclosure

Operations

Environment

Operations

Errors

Operations

HepaUv

Operations

Instruments

Operations

Labware

Operations

LabwareCategories

Operations

LabwareSignature

Operations

Lighting

Operations

LiquidClass

Operations

Maintenance

Operations

NetworkConfiguration

Operations

Power

Operations

ProtocolRun

Operations

Protocols

Operations

ProtocolSteps

Operations

ProtocolSupport

Operations

ProtocolVerification

Operations

Repair

Operations

Report

Operations

Roles

Operations

RunData

Operations

Screenshots

Operations

ServiceSoftwareApi

Operations

Settings

Operations

SoftwareVersions

Operations

SystemReady

Operations

SystemTime

Operations

ThermalDevice

Operations

Traces

Operations

UserKba

Operations

Users

Operations

Verification

Operations

/api/v1/verification/workflow/camera

Request

Security
Bearer
Body
upperVarianceinteger(int32)
lowerVarianceinteger(int32)
focusPassingboolean
upperVarianceImgstring or null
lowerVarianceImgstring or null
idinteger(int32)
verificationRunIdinteger(int32)
runobject(VerificationRun)
testPassedboolean
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/verification/workflow/camera' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "upperVariance": 0,
    "lowerVariance": 0,
    "focusPassing": true,
    "upperVarianceImg": "string",
    "lowerVarianceImg": "string",
    "id": 0,
    "verificationRunId": 0,
    "run": {
      "verificationType": "DoorSensor",
      "instrumentSerialNumber": "string",
      "runDate": "2019-08-24T14:15:22Z",
      "data": {
        "id": 0,
        "verificationRunId": 0,
        "run": {},
        "testPassed": true
      },
      "reportFilePath": "string",
      "location": "string",
      "operator": "string",
      "reason": "string",
      "verificationDevices": [
        {
          "id": 0,
          "deviceType": "ThermoHygrometer",
          "calibrationId": "string",
          "calibrationExpirationDate": "2019-08-24T14:15:22Z",
          "expirationEnabled": true
        }
      ],
      "temperature": 0.1,
      "humidity": 0.1,
      "id": 0,
      "verificationRoutineId": 0,
      "result": "NotStarted",
      "dependencyCheckFailed": true
    },
    "testPassed": true
  }'

Responses

Success

/api/v1/verification/workflow/barcode

Request

Security
Bearer
Body
upcaobject(VerificationResultBarcode)
upceobject(VerificationResultBarcode)
code128Bobject(VerificationResultBarcode)
eaN13object(VerificationResultBarcode)
eaN8object(VerificationResultBarcode)
code39object(VerificationResultBarcode)
interleaved2of5object(VerificationResultBarcode)
codabarobject(VerificationResultBarcode)
idinteger(int32)
verificationRunIdinteger(int32)
runobject(VerificationRun)
testPassedboolean
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/verification/workflow/barcode' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "upca": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "upce": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "code128B": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "eaN13": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "eaN8": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "code39": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "interleaved2of5": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "codabar": {
      "id": 0,
      "expectedResult": "string",
      "actualResult": "string"
    },
    "id": 0,
    "verificationRunId": 0,
    "run": {
      "verificationType": "DoorSensor",
      "instrumentSerialNumber": "string",
      "runDate": "2019-08-24T14:15:22Z",
      "data": {
        "id": 0,
        "verificationRunId": 0,
        "run": {},
        "testPassed": true
      },
      "reportFilePath": "string",
      "location": "string",
      "operator": "string",
      "reason": "string",
      "verificationDevices": [
        {
          "id": 0,
          "deviceType": "ThermoHygrometer",
          "calibrationId": "string",
          "calibrationExpirationDate": "2019-08-24T14:15:22Z",
          "expirationEnabled": true
        }
      ],
      "temperature": 0.1,
      "humidity": 0.1,
      "id": 0,
      "verificationRoutineId": 0,
      "result": "NotStarted",
      "dependencyCheckFailed": true
    },
    "testPassed": true
  }'

Responses

Success

Retrieves the verification configuration settings.

Request

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/verification/configuration' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The service configuration

Bodyapplication/json
isServiceContractEnabledboolean

Whether or not the service contract is enabled

contractCycleDaysinteger(int32)

The number of days for the service contract cycle

Response
application/json
{
  "isServiceContractEnabled": true,
  "contractCycleDays": 0
}

VerificationResult

Operations