Back to forum list… Back to How Do I?...

Rest API Methods (1 reply)

Dane Karcher
4 years ago
Dane Karcher 4 years ago

Questions:

  1. I see POST, PUT, MERGE, PATCH under http operations for the JSON Reader.  I'm not sure how I do a GET or DELETE.  I'm trying to test an Integration to a TMS provider that has a published REST API in Swagger Hub.  
  2. I'm assuming the URL property in the JSON Reader is the bit added to the Webservice URL setup in the Web Service behavior (WSB) so we can pass URL parameters to the endpoint.  In the WSB setup I might have https://testtms.home.com/ship/v1/shipments, then in the URL on the reader I would pass "?createdGTE={Date}" where {Date} is the variable passed into the JSON Reader.
  3. I'm confused if the &offset=0&limit=20 will automatically add to the URL if setup in the WSB.  Are these standard URL parameters to all Rest services that handle paging?

what I'm looking to create is:

https://testtms.home.com/ship/v1/shipments?createdGTE=2020-11-03T15%3A15%3A21.429Z&offset=0&limit=20

understanding that Iman will need to handle the paging in order to get all data matching the filter criteria, if more than 20 records exists as in my example.

Let me know if my questions make sense.

Erica Malcolm
4 years ago
Erica Malcolm 4 years ago

Dane,

Yes, the &offset=0&limit=20 are standard parameters and will automatically be added to the URL if setup in the WSB. See screenshot below .

Within the JSON reader , as long as the Post Request field IS NOT populated a GET operation will be performed. However you cannot perform DELETE within JSON Reader.

An example of how to configure the URL with your requirements stated above is in screenshot below.

For further information on Webservices URL setup got to

https://www.realisable.co.uk/support/Documentation/iman-user-guide/IOControllers/HTTP.htm

https://www.realisable.co.uk/support/Documentation/integration-cookbook/Webservices/WebserviceBehaviour.htm#JIRA

https://www.realisable.co.uk/wp-content/uploads/2020/11/WSB-config-1.png
https://www.realisable.co.uk/wp-content/uploads/2020/11/JSON-Reader-1.png

Contact

Realisable Software Ltd provides code-free, cost-effective applications integration solutions for SMEs. Our core IMan product is designed to integrate almost any application with a number of Sage solutions and online payment processors.

Looking to purchase IMan, please see our resellers here.

Realisable Software
Ph: +44 (0) 208 123 1017

Copyright © Realisable. All rights reserved.
Realisable is a registered trademark

Close

Request Demo

Realisable Software Ltd provides code-free, cost-effective applications integration solutions for SMEs. Our core IMan product is designed to integrate almost any application with a number of Sage solutions and online payment processors.

Looking to purchase IMan, please see our resellers here.

Realisable Software
Ph: +44 (0) 208 123 1017

Copyright © Realisable. All rights reserved.
Realisable is a registered trademark

Close

Access Downloads

Realisable Software Ltd provides code-free, cost-effective applications integration solutions for SMEs. Our core IMan product is designed to integrate almost any application with a number of Sage solutions and online payment processors.

Looking to purchase IMan, please see our resellers here.

Realisable Software
Ph: +44 (0) 208 123 1017

Copyright © Realisable. All rights reserved.
Realisable is a registered trademark

Close