REST Web Services Release Notes

Release notes are displayed in descending order from the most recent release to the oldest. Known Issues are listed with the most recent release.

See TIBCO Scribe® Online Connector For REST Web Services for more information.

Note: To access any changes to metadata support, such as new operations, entities, or fields, reset metadata for the Connection. See Resetting Metadata.

Version 1.3.1

Released June 18, 2019.

New And Noteworthy

Added support for the following: 

Closed Issues

SCREST 9 / 74062 / 74547

When testing a REST Web Services connection, the Connector did not handle a null value in the API specification correctly, which generated Object reference not set to an instance of an object errors. (Case # 68817 / 1728937)

SCREST 10 / 71379 / 71547

When making a connection using Oauth2, invalid request errors were generated because the endpoint required application/x-www-form-urlencoded, but the Connector defaulted to application/json and the grant type was not specified. (Case # 67599 / 1727723)

65825 / 63482

If you included query filters that were strings or numbers, the Connector changed the data type and value based on the content. For example, a string that contained the value 2.1 was converted to a DateTime and sent as 2/1/2018 12:00:00 am.

Known Issues

SCREST-251

Summary: If a record is returned containing a child object with a null value and no defined fields, the Connector cannot parse the record and an error similar to the following is returned: (Case # 01952707)

Object reference not set to an instance of an object

Workaround: None.

SCREST-250

Summary: When a path parameter is referenced but not specifically defined in a method in a Swagger specification, the parameter displays in the Block Properties Fields tab as a virtual field, but is not passed to the URL used to make the API call and the call fails. (Case #01930209)

Workaround: Edit the Swagger specification to include the path parameter in each method as needed.

SCREST-247

Summary: The REST Connect ClientID header configured in the Connection dialog, is not used correctly in Event apps and generates errors similar to the following. (Case # 01912994)

Operation failed. Label: Patch Patch_financeclosedInvoicesid, Name: Patch_financeclosedInvoicesidPatch, Message: An unexpected error occurred.:Exception executing method: RESTConnector.ExecuteOperation| Status: Unauthorized Unauthorized | Content: { "code": "Unauthorized", "message": "Incorrect or disabled client ID" }| Message: Unauthorized

Workaround: Manually add the clientId in all Send blocks in the app.

SCREST-246

Summary: The Connector is not refreshing the Bearer token. (Case # 01898856)

Workaround: Contact Support for Hotfix SCREST-241.

SCREST-236

Summary: Response fields from POST calls are not available in Fetch or Lookup blocks for mapping. (Case # 01886084)

Workaround: Contact Support for Hotfix SCREST-231.

SCREST-235

Summary: When interpreting body length as content-length = 0, some parameters are not being passed into the REST call. (Case # 01886733)

Workaround: Contact Support for Hotfix SCREST-230.

SCREST-225

Summary: When the authentication response includes an unexpected date format, the connector incorrectly parses the token. (Case # 01880994)

Workaround: Contact Support for Hotfix SCREST-222, which includes support for the following formats in the authentication response: epoch unix, timestamp in seconds or milliseconds.

SCREST-221

Summary: Custom headers configured in the REST Web Services Connection are not sent to the API causing intermittent 401 errors. (Case #01822857, 01843452, 01879214)

Workaround: Contact Support for Hotfix SCREST-237

SCREST-220

Summary: If an array in a REST response is null, the following error is generated: (Case # 01867855, 01888568)

Object reference not set to an instance of an object.

Workaround: Contact Support for Hotfix SCREST-216.

SCREST-206

Summary: A Valid Authorization header configured in the Connection dialog is overwritten if the Swagger specification for that Connection also contains an Authorization header parameter. (Case # 01822844, 01826672, 01846065, 01858708, 01890371)

Workaround: Remove the Authorization header parameter from the Swagger specification.

SCREST-202

Summary: Configuring a REST Web Services Connection using a large Swagger specification sometimes causes timeout exception errors or metadata is not complete. (Case # 01817752)

Workaround: Contact Support for Hotfix SCREST-200.

SCREST-197

Summary: Using a Swagger specification with a reference named responses causes the connection to fail and generates the following error: (Case # 01795485)

An item with the same key has already been added.

Workaround: The word responses is used internally by the Connector. Rename the reference to a different name.

SCREST-195

Summary: Inline schema definitions are not supported.

Workaround: Modify the Swagger specification to define the schema as a reference and use the reference as a source for GET calls.

SCREST-193

Summary: Numeric values are converted based on the regional settings of the server where the agent is installed. For example, if the value of a numeric field is 15.50 and the regional setting of the server is in the EU, that value is converted to 15,50. (Case # 01782641, 01874453)

Workaround: Update the Connect on-premise agent Windows service to run under a user account that matches the locale of the REST service.

SCREST-179 / SCREST 180

Summary: If a call to the REST API is redirected, the REST Web Services Connector redirects without an authentication header and could generate a 401 error. The underlying error might actually be a 300 level error, however 300 level errors are not displayed in the User Interface or the logs.

Workaround: In some cases, calls are redirected because the call either omitted or added a trailing slash. Adding or removing the trailing slash such that it matches the redirect location may resolve the issue.

76736 / SCREST-178

Summary: Configuring a REST Connection that uses a large Swagger specification and OAuth2 Password Grant authorization sometimes generates an error similar to the following: 

Connection test failed. Please contact Scribe Support.
Note:

Note: This error may happen with other OAuth2 settings, but has only been seen with OAuth2 Password Grant.

Workaround: Try using the Custom OAuth option on the Authorization tab or reducing the size of the specification.

SCREST-142

Summary: When attempting to upload a Swagger specification in the Connection dialog, if the endpoint requires authentication values and they are not provided on the Authorization tab an exception is generated.

Workaround: Manually retrieve a copy of the specification and paste it into the text box on the Connection dialog or configure the Authorization tab on the Connection dialog first, then upload the API specification.

68829

Summary: When using a Delete Block, if no matching record is found in the target REST datastore, a 404 error is generated, and a record error is included in the Execution History for the app.

Workaround: This error can be ignored.

68156

Summary: If you include children in a query and one of the child records has a NULL value, a NULL reference exception is generated.

Workaround: None.

Version 1.2.1

Released October 19, 2018.

New And Noteworthy

Closed Issues

64696

If the OAS specification used to define the metadata for your REST Connection contained content headers, errors similar to the one below were generated for PUT and POST operations. (Case # 65173)

Unhandled exception caught in RESTConnector.ExecuteQuery: Misused header name. Make sure request headers are used with HttpRequestMessage, response headers with HttpResponseMessage, and content headers with HttpContent objects.

Version 1.1.1

Released August 23, 2018.

New And Noteworthy

There are no new features in this release.

Closed Issues

65448 / 66041

URI parameters were being included erroneously in the body of POST calls instead of in the URL. (Case # 64869, 66415)

65826

When a query sent to a REST endpoint returned fields that were not defined in the OpenAPI Specification used to configure the Connection, the Connector generated errors similar to the following: (Case # 65434, 65286, 66350)

Message : Did not find property 'propertyName' in type 'Get_/endpoint'.

65927 / 66184

Custom headers configured on the Connection dialog were appended to API key headers instead of replacing them, which generated errors similar to the following: (Case # 65239, 66415

Message: Unhandled exception caught in RESTConnector.ExecuteQuery: Internal Server Error.

Version 1.0.0

Released April 9, 2018.

New And Noteworthy

The Connector for REST Web Services has the following features:

Closed Issues

There are no Closed Issues in this release.

Related Topics

Release Notes And Known Issues