ISM Manual
  • Overview
  • Features
  • Components
  • Directory Structure
  • Startup/Shutdown
  • ISM Admin UI
    • Dashboard
    • Flow
    • Job
      • Schedule
    • Channel
      • AMQP
      • Mqtt
      • sFTP
    • Interface
      • System
      • Data Structure
      • Field Group
      • Field
    • Web Service
    • Utility
    • Admin
    • Result
  • Tasks
    • Control Task
      • Route
      • Split/Join
      • Mapping
    • FTP
      • FTP Input
      • FTP Output
      • FTP Transfer
    • DB
      • SQL Executor
      • SQL Batch Executor
    • File
      • File Input
      • File Output
      • File Validator
      • Record Extractor
    • Excel
      • Excel Reader
      • Excel Writer
    • Flow
      • Flow Execution
      • Wait Sub
    • Web Service
      • REST Client
      • Web service Client
    • PGP
      • Encrypt
      • Decrypt
    • Cloud
      • SharePoint
      • Amazon S3
      • Google Cloud Storage
    • Others
      • Email Sender
      • LDAP Client
      • Function
      • Script
      • Java Class
  • REST Service
  • Trouble Shooting
  • Logging Configuration
  • Implementing a Task
  • Custom Class
  • Frequently Asked Questions (FAQ)
    • What is XNARUM Integration Service Mastery (ISM)?
    • What is the purpose of XNARUM?
    • Can XNARUM be customized to specific integration requirements?
    • Is XNARUM scalable?
    • Does XNARUM provide support and maintenance?
Powered by GitBook
On this page
  • Input
  • Output
  1. Tasks
  2. Web Service

REST Client

PreviousWeb ServiceNextWeb service Client

Last updated 1 year ago

The REST Client component allows users to interact with RESTful web services by making HTTP requests and receiving responses. Users can specify the HTTP method, URL, headers, and body of the request, and handle the response based on its content type. The REST Client component is commonly used in data integration workflows to retrieve or post data to external systems via RESTful APIs.

Shape Description automatically generated with low confidence

Input

Attribute
Description

URL

Service Endpoint

Service System Id

HTTP System Id

Get authentication information from the predefined system

Method

HTTP Method

GET/POST/PUT/DELETE

Authentication

Authentication Type

  • None

  • Basic

  • Digest

  • Custom

Linked Data Structure Id

Input data structure. This id is used to generate input data through mapping.

Request Format

Request Content-Type

  • JSON

  • XML

  • Form Parameter

Response Format

Request Content-Type

  • JSON

  • XML

Timeout

Service timeout(sec). The default value is 30 seconds.

Input Data

The name of the input parameter or contents

· HTTP Method

Method
Description

GET

The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.

POST

The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.

PUT

The PUT method replaces all current representations of the target resource with the request payload.

DELETE

The DELETE method deletes the specified resource.

· Authentication Type

Type
Description

Basic

Digest

Custom

Output

Attributes

Description

ResponseCode

HTTP Response code

InputMessage

Request message sent to the service

OutputMessage

Response message returned from the service

DataStructureId

Data structure id for mapping

Please refer to .

Please refer to

this chapter
this chapter