TIBCO Scribe® Online Connector for Scribe Labs

Products	Versions
TIBCO Cloud Integration - Connect ( Scribe )	1.1

Description

Introduction

The REST provides users an alternative method for working with JSON over HTTP. Paste your sample JSON payload into the Connection UI, and choose from GET, PUT, and POST verbs and configure Headers, URI, and other HTTP parameters from within the Map.

Supports both Cloud and On-Premise Agents.
Can be used with Integration and Integration Event Solutions.

Attached is a sample Map with a connection to the TIBCO Scribe® Online Platform API.

Install The Connector From The Scribe Marketplace

The REST Connector must be activated prior to use. This Connector, as well as all Connectors from TIBCO Scribe® Labs, does not count against your Connection allotment for billing purposes. In other words, it's free!

In TIBCO Scribe® Online, select Marketplace.
Scroll down and select the Connector named Scribe Labs - REST.
Click Install.

Note: It may take a few moments for the Connector to be installed.

Create A REST Connection

Select More > Connections and use the Add Icon (+) to open the Add a New Connection dialog.
In Type select "Scribe Labs - REST" from the drop-down. If it is not an option, cancel, refresh your browser, then try again.
Choose an entity Name
Choose a supported Http Verb
Paste your JSON payload
Enter a Name and for the Connection and select OK to save.
(Optional) Click Add Sample if you wish to support multiple entities from the same connection.

Http Verb Support

When you create a connection, you will choose from GET, PUT, and POST.

Http Verb	Scribe Action
GET	Query, Fetch and Lookup
POST	CreateWith
PUT	CreateWith

URI

You will provide the URI to your HTTP call as a field mapping for target operations and as a filter for Source operations.

NOTE: when providing a URI in a filter, you'll need to use an escape sequence for double-slashes:

 CONCATENATE("https:", $"//", "api.scribesoft.com:443/v1/orgs")

Headers

You will provide headers in the filter criteria (Source operation) or as Add blocks in a dictionary format. Content-Type is automatically assigned to application/json.

Cookies

Coming soon

Result Fields and Errors

The Http response from GET requests will be described in metadata from your connection. Some APIs respond with useful data in the HTTP Body and Headers; POST and PUT results will populate the ResponseBodyStr and ResponseHeaderStr fields.

ResponseBodyStr provides the raw body from the Http call. You can use PARSE() and related functions to retrieve values.
ResponseHeaderStr provides comma separated headers, with colon separated names and values pairs.

These fields will be populated on both success and failed rows, so remember to deselect the row failures feature to allow you to use Response fields from your map: https://help.scribesoft.com/scribe/en/index.htm#advsys/maps/block_error_handling.htm

Example of result fields for an errors:

 "responseBodyStr": "{\"message\":\"Authorization has been denied for this request.\"}", "responseHeaderStr": "Connection:keep-alive,Pragma:no-cache,Cache-Control:no-store, no-cache,  private,Date:Mon, 04 Mar 2019 19:12:25 GMT,Server:Microsoft-IIS/10.0,WWW-Authenticate:Bearer,Basic realm=, X-Powered-By:ASP.NET,Strict-Transport-Security:max-age=31536000", "statusCode": 401, "errorDetail": "Http call failed with StatusCode 401 - Unauthorized.", "errorDescription": "Unauthorized", "errorNumber": 0, "recordsMatched": 1, "success": false

Example of result fields for successes :

 "responseBodyStr": "{\"id\":99999,\"name\":\"nate test\",\"administrators\":[\"bpeterso@tibco.com\", \"nkeefe@tibco.com\",\"parentId\":9999,\"securityRules\":[{\"name\":\"New Rule\",\"apiAccessEnabled\":true, \"eventSolutionAccessEnabled\":true,\"allowedIpRangeStartAddress\":\"0.0.0.0\", \"allowedIpRangeEndAddress\":\"255.255.255.255\",\"id\":\"f382dcfa-dcc8-4f9a-b7b3-6e25bfd2b3b6\"}], \"apiToken\":\"e87c9dab-80d3-aaa-999-d16b0ad9da0e\"}", "responseHeaderStr": "Connection:keep-alive,Pragma:no-cache,Strict-Transport-Security:max-age=31536000, Cache-Control:no-store, no-cache,Date:Mon, 04 Mar 2019 19:19:05 GMT,Location:https://api.scribesoft.com/v1/orgs/99999, Server:Microsoft-IIS/10.0,X-Powered-By:ASP.NET", "statusCode": 201, "errorDetail": null, "errorDescription": null, "errorNumber": null, "recordsMatched": 1, "success": true

Disclaimer

No Support. You acknowledge that TIBCO will not provide any maintenance or support for this software. You have no right to receive any upgrades, patches, enhancements, bug fixes, new versions or new releases of the software.

Internal Use Only License Grant. TIBCO hereby grants you a limited, non‐transferable, non‐exclusive license to use the software solely for your internal business purposes. The name of TIBCO Software Inc. may not be used to endorse or promote products derived from this software without specific prior written permission of TIBCO Software Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT OWNERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Issue/Introduction

TIBCO Scribe Online Connector for Scribe Labs - REST provides users an alternative method for working with JSON over HTTP. Paste your sample JSON payload into the Connection UI, and choose from GET, PUT, and POST verbs and configure Headers, URI, and other HTTP parameters from within the map.

Attachments

TIBCO ScribeÂ® Online Connector for Scribe Labs - REST get_app

Welcome to "KB Articles"