AugeLab Studio Manual
English
English
  • 👋Welcome to AugeLab Studio User Manual
  • 📘Introduction
    • AugeLab Studio
    • Key Features
    • Use Cases
    • System Requirements
  • 🚀Getting Started
    • Signing up
    • Installation
    • First Look
    • Simple Tour
    • Your Very First Project
      • Basics
      • Detection
      • Wrapping Up
    • More Local Examples
    • Further Reading
  • đŸ–Ĩī¸AugeLab Studio Interface
    • Detailed Look
    • Scenario Area
    • Menu and Toolbar
    • Managing Projects
    • Installing AI and much more
      • Leverage AI with Module Downloader
  • 🧱Function Blocks
    • Block Structures
    • Sockets
    • Blocks Column
    • Connections
    • All Function Blocks
      • AI Blocks
        • Face Detection
        • Mask Detection
        • Object Detection - Custom
        • Object Detection
        • Pose Estimation
        • Safety Equipment Detection
        • Social Distance Detector
        • Super Resolution
        • Text Detection
        • OCR
      • CNN Blocks
        • Average Pooling 2D
        • Batch Normalization
        • Choose Folder 2D
        • Compile Model
        • Conv. Sep. Layer 2D
        • Conv. Trans. Layer 2D
        • Convolutional Layer 2D
        • Dropout Layer
        • Flatten Layer 2D
        • Fully Connected
        • Global Average Pooling 2D
        • Global Max Pooling 2D
        • Input Layer 2D
        • Loss CCE
        • Max Pooling 2D
        • Metrics Accuracy
        • Model EfficientNet
        • Model MobileNet
        • Model ResNet
        • Model VGG
        • Optimizer Adadelta
        • Optimizer Adagrad
        • Optimizer Adam
        • Optimizer Adamax
        • Optimizer FTRL
        • Optimizer Nadam
        • Optimizer RMSProp
        • Optimizer SGD
        • ReLU Layer
        • Softmax Layer
        • Training Parameters
      • Data/Logic
        • Flow Control
          • Batch Concatenation
          • Batch Processing
          • Debatch
          • Get Batch Size
          • HMI Background
          • Subsystem Enabled
          • Subsystem In
          • Subsystem Loop
          • Subsystem Out
          • Subsystem
        • logic
          • All True
          • And
          • Demux
          • Equals
          • Greater
          • Logic Operations
          • Mux
          • Not
          • Or
          • Set - Reset
          • Smaller
        • Mathmetical Operations
          • Add
          • Counter
          • Divide
          • Math Operations
          • Maximum
          • Minimum
          • Multiply
          • Not Equals
          • Round
          • Square Root
          • Subtract
          • Trigonometry
        • Data Operations
          • Data Memory
          • Data to JSON
          • Data Type Converter
          • Datetime Compare
          • Dictionary Operations
          • Exclude Nones
          • Find Substring
          • Get Element
          • Is None
          • List Operations
          • Parse Data Dictionary
          • Replace None
          • String Merge
          • String Operations
        • Referencing
          • Data Read Global
          • Data Read Local
          • Data Write Global
          • Data Write Local
          • Debug Input
          • Tag From
          • Tag To
        • Signal Operators
          • Delay Step
          • Edge Falling
          • Edge Rising
          • Multi Port Switch
          • OFF Delay
          • ON Delay
      • Image/Transformations
        • Analysis
          • Color Density Percentage
          • Get Dimension
          • Histogram On Curve
          • Histogram On Line
          • Image Color Match
          • Image Memory
          • Image Resolution and Channel Value
          • Maximum Images
          • Mean Value of Image
          • Measure Position Distance
          • Minimum Images
          • Non-zero of Image
          • Std. of Image
          • Structural Similarity
        • Transformation Filters
          • Auto Alignment
          • Auto Contrast
          • Color Quantizer and Clustering
          • Color Space
          • Contrast-Brightness-Gamma
          • Contrast Optimization
          • Deconvolution
          • Denoising
          • Distance Transformation
          • FloodFill
          • Grab Cut Algorithm
        • Color Filters
          • 2D Filter
          • Apply Mask
          • Bilateral Filter
          • Blur
          • Edge Filter
          • HSV Filter
          • Image Adaptive Threshold
          • Image Threshold
          • Invert Image
          • Morphological Transformations
          • Normalize Image
          • RGB Mask
          • RGB Set
          • Sobel Filter
        • Operations
          • Add Images Weighted
          • Add Images
          • Collage Images
          • Divide Images
          • Flip Image
          • Image AutoRotator
          • Image Concatenate
          • Image Resize
          • Image Resizer
          • Merge Channels
          • Multiply Images
          • Polar Transform
          • Rotate Image Angle
          • Slice Image
          • Split Image
          • Subtract Images
      • Detections/Shapes
        • Detectors
          • Barcode Reader
          • Blob Detector
          • Blur Detector
          • Circle Detector
          • Corner Detector
          • Custom CNN Model
          • Data Matrix Reader
          • Detect Reference
          • Feature Detector
          • Find Object - Multiple Image
          • Find Object
          • Find Reference
          • Harris Corner Filter
          • Line Detector
          • Match Shapes
          • Measure Object Distance
          • Shape Detector
        • Draw
          • Draw Detections
          • Draw Line
          • Draw Point
          • Draw Rectangle
          • Draw Result On Image
          • Write Date On Image
          • Write Text On Image
        • Roi Processing
          • Check Area (Polygon)
          • Check Area
          • Get Pixel Mouse
          • Get Pixel
          • Get ROI
          • Image ROI Center
          • Image ROI Polygon
          • Image ROI Select Multi
          • Image ROI Select
          • Image ROI
          • Perspective Transform
          • Rectangles in Rectangle
        • Shape Analysis
          • Approximate Contour
          • Choose Line
          • Contour to Image
          • Fill Contour
          • Find Contour
          • Hull Convex
          • Minimum Circle
          • Minimum Ellipse
          • Minimum Rectangle
          • Minimum Rotated Rectangle
          • Most Similar Shape
          • Point Polygon Test
      • Input/Output
        • Communication
          • Modbus Connect
          • Modbus Read
          • Modbus Write
          • MQTT Publish
          • MQTT Subscribe
          • OPC UA Client
          • OPC UA Read
          • OPC UA Write
          • REST API - Get
          • REST API - Post
          • Send Mail
          • Siemens S7 Connect
          • Siemens S7 Read
          • Siemens S7 Write
        • Data Inputs
          • Date-Time List
          • Date-Time
          • Headless Check
          • Keyboard/Barcode Reader
          • Logic Input
          • Number Input
          • Number Range
          • PWM (Pulse Width Modulation)
          • Rising Edge
          • String Input
          • Text
        • Image Inputs
          • Camera IP (ONVIF)
          • Camera IP
          • Camera USB External
          • Camera USB Vidgear
          • Camera USB
          • Load Image From Path
          • Load Image
          • Make Image
          • Pixel
          • Video
        • Outputs/Exports
          • CSV Export
          • Cycle Timer
          • File/Folder Operations
          • GPU Statistics
          • Image Logger
          • Image Write
          • Led Output
          • Multi Image Write
          • Output
          • Scope
          • Show Image
          • Stop
  • 📡Devices and Communication
    • Camera Usage
    • Communication Protocols
    • Further Reading
  • 🧩Example Projects
    • Demo Projects
    • Circumference Measurement
    • Object Counting
    • Tile Width Measurement
    • Human Detection
    • Object Detection
  • 🔑Key Features
    • Deploy Custom HMI Applications
    • Annotate Data for Object Detection
    • Train Custom AI Models
      • Choosing the Right Database
      • When to Stop Training
    • Create Plugins
      • Components
      • Coding Reference
    • Share Your Solutions with Community
    • Instal Python Packages
  • 📑FAQ
    • Contact Us
    • FAQ
    • Setting up a full project
  • Additional Resources
    • Training Schedule
    • Training Materials
    • AugeLab Experts
  • Appendix
    • Dictionary
    • References
Powered by GitBook
On this page
  • đŸ“Ĩ Inputs
  • 📤 Outputs
  • đŸ•šī¸ Controls
  • 🎨 Features
  • 📝 Usage Instructions
  • 📊 Evaluation
  • 💡 Tips and Tricks
  • đŸ› ī¸ Troubleshooting

Was this helpful?

  1. Function Blocks
  2. All Function Blocks
  3. Input/Output
  4. Communication

REST API - Post

This function block allows you to send data to a specified REST API endpoint using a POST request. It is suitable for integrating your application with external services through an API.

đŸ“Ĩ Inputs

Enable Condition A boolean input that controls whether the POST request is sent. If set to true, the request will be executed.

Server Address The URL of the server where the data should be posted.

Data ID A string identifier for the data being sent. This serves as a key in the JSON object.

Data The actual data to be sent to the server. This can be any type of data that needs to be posted.

📤 Outputs

Status Code This output provides the HTTP status code returned from the server, indicating the success or failure of the request.

Error This output returns an error message if the request failed.

Response This output provides the response text received from the server.

đŸ•šī¸ Controls

Timeout (s) This field allows you to set a timeout duration for the request in seconds. If the server does not respond within this time, the request will fail.

🎨 Features

Dynamic Request Configuration The ability to specify a server address, data ID, and payload dynamically allows for flexible integration with various APIs.

Comprehensive Feedback Outputs include status code, potential error messages, and responses, making it easy to debug and validate the request.

📝 Usage Instructions

  1. Enable Condition: Connect a boolean signal to the Enable Condition input to allow or disallow the request to be sent.

  2. Set Server Address: Enter the server address in the Server Address input.

  3. Define Data ID: Provide a string identifier for your data.

  4. Provide Data: Connect or input the data you wish to post.

  5. Set Timeout: Optionally, set the timeout duration for the request.

  6. Evaluate: Run the block to send the data to the API, and review the outputs for status code, response, or errors.

📊 Evaluation

This function block evaluates the inputs to send a POST request to the configured REST API and provides outputs to allow you to handle the response effectively.

💡 Tips and Tricks

Check API Documentation

Make sure to check the API documentation of the server you are interfacing with. Some APIs may require specific headers or authentication tokens.

Validating Responses

If you expect a specific response structure, consider post-processing the response string to convert it into a dictionary or structured object for easier handling.

Using Mock Servers

If you are developing and testing, consider using mock servers like Postman or Mocky, where you can simulate API responses without hitting live endpoints.

đŸ› ī¸ Troubleshooting

Connection Issues

If you encounter issues connecting to the server, ensure that the server address is correct and reachable from your network. Test the URL in a browser or tool like Postman.

Invalid Data Format

If the request fails due to invalid data format, ensure that the data you are sending matches the expected format as outlined in the API documentation.

Timeout Errors

If you receive timeout errors, consider increasing the timeout value in the timeout settings. This can be necessary for slow responding servers.

PreviousREST API - GetNextSend Mail

Last updated 8 months ago

Was this helpful?

🧱