--- updatedAt: 2026-09-01T11:27:16.000Z agentTools: projectIndex: https://documentation.nedap-harmony.com/llms.txt --- # ActionReadPoint Send an action to a readPoint. # OpenAPI definition ```json { "openapi": "3.0.4", "info": { "title": "Harmony API - Public", "version": "v1" }, "servers": [ { "url": "https://nedap-harmony.com" } ], "paths": { "/api/{workspaceId}/read-points/v1/{readPointReference}/action": { "post": { "tags": [ "ReadPoint" ], "summary": "ActionReadPoint", "description": "Send an action to a readPoint.", "operationId": "ActionReadPoint", "parameters": [ { "name": "readPointReference", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "path", "description": "WorkspaceId of the workspace the API call is for.", "required": true, "schema": { "type": "string", "description": "WorkspaceId of the workspace the API call is for.", "format": "uuid" } }, { "name": "test", "in": "query", "description": "Whether this is a request for 'Test' or 'Live' environment. True refers to the 'Test' environment, no value or False refers to the 'Live' environment.", "schema": { "type": "boolean", "description": "Whether this is a request for 'Test' or 'Live' environment. True refers to the 'Test' environment, no value or False refers to the 'Live' environment." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadPointAction" } } } }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests" } }, "security": [ { "apiToken": [ "write:readpoint:actions" ] } ] } } }, "components": { "schemas": { "AutomationContainerParameters": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "expectedQuantity": { "type": "integer", "format": "int32", "nullable": true }, "cancelConfirm": { "type": "boolean", "nullable": true }, "epcPredictions": { "type": "array", "items": { "$ref": "#/components/schemas/EpcPrediction" }, "nullable": true }, "epcDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationEpcDetails" }, "nullable": true }, "containerPassedAntennaTimeMilliseconds": { "type": "number", "format": "double", "nullable": true }, "conveyorSpeedMeterPerSecond": { "type": "number", "format": "double", "nullable": true }, "observationsPreAntennaTimeoutMilliseconds": { "type": "number", "format": "double", "nullable": true }, "observationsPostAntennaTimeoutMilliseconds": { "type": "number", "format": "double", "nullable": true }, "tunnelIsClosed": { "type": "boolean" } }, "additionalProperties": false }, "AutomationEpcDetails": { "type": "object", "properties": { "epc": { "$ref": "#/components/schemas/Epc" }, "relativeTimestamps": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true }, "rssiValues": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true }, "antennas": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "speeds": { "type": "array", "items": { "type": "number", "format": "double", "nullable": true }, "nullable": true }, "speedRelativeTimestamps": { "type": "array", "items": { "type": "number", "format": "double", "nullable": true }, "nullable": true }, "frequencies": { "type": "array", "items": { "type": "number", "format": "double", "nullable": true }, "nullable": true }, "phases": { "type": "array", "items": { "type": "number", "format": "double", "nullable": true }, "nullable": true }, "stray": { "type": "boolean", "nullable": true }, "score": { "type": "number", "format": "float", "nullable": true } }, "additionalProperties": false }, "AutomationStateEnum": { "enum": [ "Disconnected", "WaitingForReset", "Resetting", "EmergencyStopActive", "Stopped", "Starting", "Operational" ], "type": "string" }, "AutomationStateParameters": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/AutomationStateEnum" }, "emergencyStopActiveReason": { "type": "string", "nullable": true }, "healthNotOk": { "type": "boolean", "nullable": true }, "healthNotOkReason": { "type": "string", "nullable": true }, "bufferContainerWait": { "type": "boolean", "nullable": true }, "forwardLaneFull": { "type": "boolean", "nullable": true }, "exitLaneFull": { "type": "boolean", "nullable": true }, "tunnelHatchClosed": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "BarcodeActionParameters": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BarcodeType" }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BarcodeType": { "enum": [ "AustralianPostal", "Aztec", "BooklandEan", "CanadianPostal", "Chinese2Of5", "Codabar", "Code11", "Code128", "Code16K", "Code32", "Code39", "Code39FullAscii", "Code49", "Code93", "CompositeAb", "CompositeC", "Coupon", "Discrete2Of5", "DatabarCoupon", "DataMatrix", "DotCode", "DutchPostal", "Ean128", "Ean13", "Ean8", "FinnishPostal4s", "GridMatrix", "Gs1DataBar", "Gs1DataBarExpanded", "Gs1DataBarLimited", "Gs1DataMatrix", "Gs1QrCode", "Hanxin", "Interleaved2Of5", "Iata2Of5", "Isbt128", "JapanesePostal", "Korean3Of5", "Mailmark", "Matrix2Of5", "MaxiCode", "MicroPdf", "MicroPdfCca", "MicroQr", "Msi", "Nw7", "Ocr", "Pdf417", "PostnetUs", "QrCode", "Signature", "Tlc39", "Trioptic3Of9", "UkPostal", "Undefined", "UpcA", "UpcD", "UpcE0", "UpcE1", "Us4State", "Us4StateFics", "UsPlanet", "UsPostNet", "Webcode" ], "type": "string" }, "Epc": { "type": "object", "properties": { "pcWord": { "$ref": "#/components/schemas/PcWord" }, "gs1": { "$ref": "#/components/schemas/Gs1Epc" }, "trueVue": { "$ref": "#/components/schemas/TrueVueEpc" }, "hexadecimal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EpcPrediction": { "type": "object", "properties": { "epc": { "$ref": "#/components/schemas/Epc" }, "stray": { "type": "boolean" }, "confidenceScorePercentage": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GpioState": { "type": "object", "properties": { "portNumber": { "type": "integer", "format": "int32" }, "level": { "type": "boolean" } }, "additionalProperties": false }, "Gs1Epc": { "type": "object", "properties": { "parameters": { "type": "object", "nullable": true, "readOnly": true }, "pureIdentityUri": { "type": "string", "nullable": true, "readOnly": true }, "bareIdentifier": { "type": "string", "nullable": true, "readOnly": true }, "type": { "type": "string", "nullable": true, "readOnly": true }, "reference": { "type": "string", "nullable": true, "readOnly": true }, "elementString": { "type": "string", "nullable": true, "readOnly": true }, "legacy": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true }, "legacyAi": { "type": "string", "nullable": true, "readOnly": true, "deprecated": true } }, "additionalProperties": false }, "HandheldTriggerParameters": { "type": "object", "properties": { "pressed": { "type": "boolean" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HookResultParameters": { "type": "object", "properties": { "jobId": { "type": "string", "nullable": true }, "error": { "nullable": true }, "result": { "nullable": true } }, "additionalProperties": false }, "OperationLogTime": { "type": "object", "properties": { "unixTimeSeconds": { "type": "integer", "format": "int32" }, "increment": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PcWord": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32" }, "umi": { "type": "boolean" }, "xi": { "type": "boolean" }, "t": { "type": "boolean" }, "afi": { "type": "integer", "format": "int32", "nullable": true }, "attributeBits": { "type": "integer", "format": "int32", "nullable": true }, "hazardousMaterial": { "type": "boolean", "nullable": true, "readOnly": true }, "nonRemovable": { "type": "boolean", "nullable": true, "readOnly": true }, "killable": { "type": "boolean", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "PrinterLabelPrintedParameters": { "type": "object", "properties": { "currentLabelForTrigger": { "type": "integer", "format": "int32", "nullable": true }, "numberOfLabelsForTrigger": { "type": "integer", "format": "int32", "nullable": true }, "rfidError": { "type": "string", "nullable": true }, "epc": { "$ref": "#/components/schemas/Epc" }, "tid": { "$ref": "#/components/schemas/Tid" } }, "additionalProperties": false }, "PrinterStateParameters": { "type": "object", "properties": { "headOpen": { "type": "boolean", "nullable": true }, "coverOpen": { "type": "boolean", "nullable": true }, "paused": { "type": "boolean", "nullable": true }, "paperOut": { "type": "boolean", "nullable": true }, "ribbonOut": { "type": "boolean", "nullable": true }, "currentLabelForTrigger": { "type": "integer", "format": "int32", "nullable": true }, "currentTid": { "$ref": "#/components/schemas/Tid" }, "numberOfLabelsForTrigger": { "type": "integer", "format": "int32", "nullable": true }, "isConfigChannelOpen": { "type": "boolean", "nullable": true }, "isRawChannelOpen": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "ReadPointAction": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "type": { "$ref": "#/components/schemas/ReadPointActionType" }, "triggerId": { "type": "string", "nullable": true }, "bridged": { "type": "boolean", "nullable": true }, "additionalInformation": { "nullable": true }, "rfid": { "$ref": "#/components/schemas/RfidActionParameters" }, "rfidAccessResult": { "$ref": "#/components/schemas/RfidAccessResultParameters" }, "rfidStartReadingResult": { "$ref": "#/components/schemas/RfidStartReadingResultParameters" }, "rfidEnabled": { "$ref": "#/components/schemas/RfidEnabledParameters" }, "handheldTrigger": { "$ref": "#/components/schemas/HandheldTriggerParameters" }, "gpi": { "type": "array", "items": { "$ref": "#/components/schemas/GpioState" }, "nullable": true }, "barcode": { "$ref": "#/components/schemas/BarcodeActionParameters" }, "printerState": { "$ref": "#/components/schemas/PrinterStateParameters" }, "printerLabelPrinted": { "$ref": "#/components/schemas/PrinterLabelPrintedParameters" }, "automationState": { "$ref": "#/components/schemas/AutomationStateParameters" }, "automationContainer": { "$ref": "#/components/schemas/AutomationContainerParameters" }, "hookResult": { "$ref": "#/components/schemas/HookResultParameters" }, "rfidAntennaConnectionChangedPort": { "type": "integer", "format": "int32", "nullable": true }, "rfidAntennaConnectionChangedNewState": { "type": "boolean", "nullable": true }, "thirdPartyEpcRead": { "$ref": "#/components/schemas/ThirdPartyEpcReadParameters" }, "systemLogsExtracted": { "$ref": "#/components/schemas/SystemLogsExtractedParameters" }, "readPointId": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time", "nullable": true }, "operationLogTime": { "$ref": "#/components/schemas/OperationLogTime" }, "test": { "type": "boolean", "nullable": true, "readOnly": true }, "lastModification": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ReadPointActionType": { "enum": [ "RfidArrive", "RfidStay", "RfidLeave", "RfidCurrent", "RfidAntennaChange", "RfidAccessResult", "RfidStartReadingResult", "RfidSummary", "RfidEnabledChange", "HandheldTriggerChange", "GpiChange", "BarcodeRead", "NoBarcodeRead", "PrinterLabelPrinted", "AutomationTunnelContainerEnter", "AutomationTunnelContainerExit", "HookResult", "State", "External", "RfidAntennaConnectionChanged", "ThirdPartyEpcReads", "SystemLogsExtracted" ], "type": "string" }, "RfidAccessOperationType": { "enum": [ "Read", "Write", "Kill", "Authenticate" ], "type": "string" }, "RfidAccessResultParameters": { "type": "object", "properties": { "accessedEpc": { "$ref": "#/components/schemas/Epc" }, "operation": { "$ref": "#/components/schemas/RfidAccessOperationType" }, "result": { "$ref": "#/components/schemas/RfidAccessResultType" }, "readData": { "type": "string", "nullable": true }, "numberOfWordsWritten": { "type": "integer", "format": "int32", "nullable": true }, "authenticationResponse": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RfidAccessResultType": { "enum": [ "Pending", "Success", "ReaderNoTagFoundError", "ReaderNonSpecificError", "ReaderTimeoutError", "ReaderIncorrectPasswordError", "ReaderNoResponseFromTagError", "TagOtherError", "TagNotSupportedError", "TagInsufficientPrivilegesError", "TagMemoryOverrunError", "TagMemoryLockedError", "TagCryptoSuiteError", "TagCommandNotEncapsulatedError", "TagResponseBufferOverflowError", "TagSecurityTimeoutError", "TagInsufficientPowerError", "TagNonSpecificError", "TagZeroKillPasswordError", "Unknown" ], "type": "string" }, "RfidActionParameters": { "type": "object", "properties": { "epcs": { "type": "array", "items": { "$ref": "#/components/schemas/Epc" }, "nullable": true }, "rfidTags": { "type": "array", "items": { "$ref": "#/components/schemas/RfidTag" }, "nullable": true }, "primary": { "$ref": "#/components/schemas/RfidTag" }, "perAntenna": { "type": "array", "items": { "$ref": "#/components/schemas/RfidPerAntennaParameters" }, "nullable": true }, "perSubLocation": { "type": "array", "items": { "$ref": "#/components/schemas/RfidPerSubLocationParameters" }, "nullable": true }, "triggeringBarcode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RfidEnabledParameters": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "RfidPerAntennaParameters": { "type": "object", "properties": { "epcs": { "type": "array", "items": { "$ref": "#/components/schemas/Epc" }, "nullable": true }, "rfidTags": { "type": "array", "items": { "$ref": "#/components/schemas/RfidTag" }, "nullable": true }, "antenna": { "type": "integer", "format": "int32", "nullable": true }, "previousAntenna": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RfidPerSubLocationParameters": { "type": "object", "properties": { "epcs": { "type": "array", "items": { "$ref": "#/components/schemas/Epc" }, "nullable": true }, "subLocationUri": { "type": "string", "nullable": true }, "previousSubLocationUri": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RfidStartReadingResultParameters": { "type": "object", "properties": { "started": { "type": "boolean" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RfidTag": { "type": "object", "properties": { "epc": { "$ref": "#/components/schemas/Epc" }, "tid": { "$ref": "#/components/schemas/Tid" }, "userMemory": { "$ref": "#/components/schemas/UserMemory" } }, "additionalProperties": false }, "SystemLogsExtractedParameters": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ThirdPartyEpcReadParameters": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "shipmentReference": { "type": "string", "nullable": true }, "epcs": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Tid": { "type": "object", "properties": { "xtidPresent": { "type": "boolean", "nullable": true, "readOnly": true }, "security": { "type": "boolean", "nullable": true, "readOnly": true }, "file": { "type": "boolean", "nullable": true, "readOnly": true }, "manufacturerNumber": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "modelNumber": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "manufacturerName": { "type": "string", "nullable": true, "readOnly": true }, "modelName": { "type": "string", "nullable": true, "readOnly": true }, "xtid": { "$ref": "#/components/schemas/Xtid" }, "wordPointer": { "type": "integer", "format": "int32" }, "hexadecimal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TrueVueEpc": { "type": "object", "properties": { "type": { "type": "string", "nullable": true, "readOnly": true }, "reference": { "type": "string", "nullable": true, "readOnly": true }, "serial": { "type": "string", "nullable": true, "readOnly": true }, "pureIdentityUri": { "type": "string", "nullable": true, "readOnly": true }, "tagUri": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserMemory": { "type": "object", "properties": { "wordPointer": { "type": "integer", "format": "int32" }, "hexadecimal": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Xtid": { "type": "object", "properties": { "extendedHeaderPresent": { "type": "boolean", "nullable": true, "readOnly": true }, "userMemoryAndBlockPermaLockSegmentPresent": { "type": "boolean", "nullable": true, "readOnly": true }, "blockWriteAndBlockEraseSegmentPresent": { "type": "boolean", "nullable": true, "readOnly": true }, "optionalCommandSupportSegmentPresent": { "type": "boolean", "nullable": true, "readOnly": true }, "serialisationLengthInBits": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "serialHexadecimal": { "type": "string", "nullable": true, "readOnly": true }, "serialDecimal": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "hexadecimal": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "apiToken": { "type": "http", "description": "Enter the obtained API Token.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "apiToken": [] } ], "x-samples-languages": [ "curl", "javascript", "csharp", "java", "python" ] } ```