ProcessMIX Guide
  • Platform Overview
    • Introduction
    • Platform Purpose
    • Main Concepts
      • Organization Structure
      • Visual Language
      • Project Development Environment (IDE)
      • Deployment and Integration
      • Administration and Troubleshooting
    • First Steps
    • Change Log
      • 5.0.0
      • 5.0.5
      • 5.0.5.1
      • 5.0.5.2
      • 5.0.5.3
      • 5.0.5.4
  • Language Reference Guide
    • Overview
    • Data Structures and Types
      • Core Types (pdk.core)
      • Dictionary (pdk.asset.dictionary)
      • Scorecard (pdk.asset.scorecard)
      • Blockchain (pdk.blockchain)
      • Exceptions (pdk.ex)
      • Input/Output (pdk.io)
      • JSON Web Token (pdk.jwt)
      • Networking (pdk.net)
      • HTTP (pdk.net.http)
      • SOAP/Web Services (pdk.net.soap)
      • XML/DOM (pdk.net.xml)
      • S3 (pdk.s3)
      • SQL (pdk.sql)
      • Postgres (pdk.db.postgre)
      • Util (pdk.util)
      • Default Data Structure Field Values
    • Flows
      • Variables
        • Local Flow Variables
        • Node Variables
      • Flow Node Types
        • Core Nodes
          • In
          • Out
          • Assign
          • If
          • Switch
          • Iterator
          • Function Call
          • Subflow
          • Raise Exception
          • Exception Handler
          • Validator
        • Connector Nodes
          • Database Begin Transaction
          • Database Commit Transaction
          • Database Rollback Transaction
          • Database Query Executor
          • EVM Blockchain Functions
          • EVM Blockchain Smart Contract Functions
          • REST Service Executor
          • SOAP Service Executor
          • S3 Connector
          • SMB Connector
      • Expressions
      • Built-In Functions
        • Expression functions
          • pdk.util.Any
          • pdk.util.Array
          • pdk.util.Blockchain
          • pdk.util.Cast
          • pdk.util.Codec
          • pdk.util.Crypto
          • pdk.util.Date
          • pdk.util.File
          • pdk.util.Json
          • pdk.util.JWT
          • pdk.util.Map
          • pdk.util.Math
          • pdk.util.String
          • pdk.util.Util
        • Node functions
          • pdk.flow.Any
          • pdk.flow.Array
          • pdk.flow.File
          • pdk.flow.JsonArray
          • pdk.flow.JsonObject
          • pdk.flow.HttpRequest
          • pdk.flow.HttpResponse
          • pdk.flow.Logger
          • pdk.flow.Map
          • pdk.flow.Xml
            • pdk.flow.xml.XmlAttr
            • pdk.flow.xml.XmlElement
            • pdk.flow.xml.XmlNode
            • pdk.flow.xml.XmlDocument
            • pdk.flow.xml.XmlDocumentType
            • pdk.flow.xml.XmlDOMConfiguration
            • pdk.flow.xml.XmlDOMImplementation
            • pdk.flow.xml.XmlProcessingInstruction
            • pdk.flow.xml.XmlTypeInfo
            • pdk.flow.xml.XmlCharacterData
            • pdk.flow.xml.XmlText
            • pdk.flow.xml.XmlNamedNodeMap
          • pdk.node.BlockchainEth
          • pdk.node.S3
          • pdk.node.Smb
      • Exceptions
        • Checked Exceptions
        • Runtime Exceptions
    • Assets
      • Dictionary
      • Decision Table
      • Scorecard
      • PMML
    • Connectors
      • DB Connector
        • Prepared Query
        • Dynamic Query
        • Query input parameters
        • Stored Procedure
      • REST Connector
      • SOAP Connector
      • S3 Connector
      • SMB Connector
      • EVM Blockchain Connector
    • Global Variables
    • Appendices
      • Overview of Database Transactions
      • Reserved Words
  • Project Development Environment (IDE)
    • Project Explorer Panel
    • Flow Builder
    • Flow Node Editor
    • Data Structure Builder
    • Connector Builders
      • REST Connector Builder
      • SOAP Connector Builder
      • DB (Database) Connector Builder
      • EVM Blockchain Connectors Builder
      • S3 Connector Builder
    • Asset Builders
      • Dictionary Builder
      • Decision Table Builder
      • Scorecard Builder
      • PMML Asset Builder
    • Global Variables Panel
    • Expression Editor
    • Project Deployment and Execution
    • Cron Expression Generator
    • Test Helper
    • Debugging the Project
    • DB transactions
    • Team Collaboration Tools
      • Version Control
      • Conflict Resolver
    • Selectors
    • Error Panel
    • Local History
  • Home and Administration Guide
    • Organization and Subscription
    • Organization Team
    • Repositories and Projects
    • Environments
    • Deployments
    • Database Provisioning
    • Roles and Permissions
  • Logs and Troubleshooting
    • Request/Call Logs
    • Deployment Logs
    • Application Logs
  • Appendix: Example Project
    • Risk Mitigation Solution
Powered by GitBook
On this page
  • Settings
  • Name
  • Base URL
  • Description
  • Services
  • Settings
  1. Language Reference Guide
  2. Connectors

REST Connector

PreviousStored ProcedureNextSOAP Connector

Last updated 6 months ago

This connector enables communication with external web services using HTTP REST ("Representational State Transfer") protocol.

Settings


Name

Refers to the unique identifier.

Type
Restrictions

input Text

  • must consist of letters (A-Z or a-z), digits (0-9), underscores (_), or dollar signs ($). However, a class name cannot start with a digit and dollar sign ($)

  • Unique per folder

  • Mandatory

  • Min length: 1

  • Max length: 255


Base URL

Refers to the fundamental endpoint that serves as the starting point for all API requests made through that connector. This base URL typically represents the root URL of the RESTful API you are connecting to.

Type:

Example:

https://api.example.com/users/{id}/address

Base URL: https://api.example.com

Global variables allow the definition of different values for development, test, pre-production, and production environments.


Description

Provides additional information about the connector itself. This description is often used to document the purpose, functionality, usage instructions, or any other relevant details about the connector.


Services

Facilitates interaction with RESTful APIs. This service abstracts away the complexities of HTTP communication and provides a simplified interface for making requests to remote APIs and handling responses.

Settings

URL

Type: input text - string

Example:

https://api.example.com/users/{id}/address

URL: /users/{id}/address


Method

Defines the action to be performed on a resource identified by a URL. These methods are part of the HTTP protocol and provide a standardized way for clients to interact with resources on a server. HTTP methods in RESTful services are:

  1. GET: The GET method is used to retrieve data from the server. It should be idempotent, meaning that making the same request multiple times should have the same effect as making it once.

  2. POST: The POST method is used to send data to the server to create a new resource. It is not idempotent, meaning that making the same request multiple times may result in different resources being created.

  3. PUT: The PUT method is used to update an existing resource on the server. It should be idempotent, meaning that making the same request multiple times should have the same effect as making it once.

  4. DELETE: The DELETE method is used to delete a resource from the server. It should be idempotent, meaning that making the same request multiple times should have the same effect as making it once.

  5. PATCH: The PATCH method is used to apply partial modifications to a resource. It is typically used when only a subset of the resource's properties need to be updated.

  6. HEAD: The HEAD method is similar to GET but is used to retrieve only the headers of a response, without the body. It is often used to check the status of a resource without downloading its entire content.

  7. OPTIONS: The OPTIONS method is used to retrieve information about the communication options available for a resource, such as supported HTTP methods and headers.

Type: select


Request

Refers to the format and content of the data that a client sends to the server when making a request. The request structure typically consists of various properties or components that convey information about the client's intent, the desired operation, and any data associated with the request.


Response

Refers to the format and content of the data that the server sends back to the client in response to a request. The response structure typically consists of various properties or components that convey information about the outcome of the request, the requested resource, and any additional metadata.


Error response

Refers a standardized structure to convey information about encountered errors or exceptions during the processing of a request. This structure typically includes various properties or components that provide details about the error, enabling the client to understand the nature of the problem and take appropriate action.

The error response contains information only if the HTTP status is not 'OK'. (HTTP status: 2XX)


Path parameters

Path parameters are dynamic segments within the URL endpoint that are used to identify and retrieve specific resources. They are part of the URL path and are specified by placing them within curly braces {}. Path parameters provide a way to pass variable values to the server in the URL itself, allowing clients to interact with resources in a flexible and expressive manner.

Each parameter has two properties:

  • name - input text

Example:

https://api.example.com/users/{id}/address

Parameter: id

  • name - id

  • type - Integer


Request parameters

Refer to the data sent by the client to the server as part of an HTTP request. These parameters are used to provide additional information to the server, such as specifying the operation to perform, filtering data, or providing input for processing.

Each parameter has two properties:

  • name - input text

Example:

https://api.example.com/users/{id}/address?limit={limitValue}&orderBy={orderValue}

Parameter: limit

  • name - limitValue

  • type - Integer

Parameter: orderBy

  • name - orderValue

  • type - String


Headers and cookies

Base URL should be defined as . This enables the redefinition of values for new deployments.

Refers to a URL that is specified relative to a . When making requests to a RESTful API, the relative URL is appended to the base URL to form the complete endpoint for the API request.

Use structure for the empty payload

Use structure for multipart/form-data request

Use structure for application/octet-stream

Use structure for text/plain and other text/*

Type:

Use structure for the empty response

Use structure for multipart/form-data request

Use structure for application/octet-stream

Use structure for text/plain and other text/*

Custom for application/json

Use structure for generic responses

Type:

Use structure for generic responses

Type:

type - (only , , and are allowed)

type - (only , , and are allowed)

Headers and cookies should be defined as properties of the node.

global variables
structures
REST Service Executor
global variable
Name
Base URL
Description
URL
Method
Request
Response
Error response
Path parameters
Request parameters
Headers and cookies
connector base URL
Reserved words
JsonObject
JsonObject
String
String
File
File
Integer
Float
Boolean
String
Integer
Float
Boolean
String
structure selector
structure selector
structure selector
structure selector
structure selector
EmptyRequest
FormData
EmptyResponse
FormData